Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
28 changes: 28 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'darker'
copyright = '2020–2024, Antti Kaihola'
author = 'Antti Kaihola'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

templates_path = ['_templates']
exclude_patterns = []

root_doc = 'index'


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']
114 changes: 114 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
Welcome to Darker's Documentation!
===================================

|build-badge| |license-badge| |pypi-badge| |downloads-badge| |black-badge| |changelog-badge|

.. |build-badge| image:: https://github.com/akaihola/darker/actions/workflows/python-package.yml/badge.svg
:alt: master branch build status
:target: https://github.com/akaihola/darker/actions/workflows/python-package.yml?query=branch%3Amaster
.. |license-badge| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:alt: BSD 3 Clause license
:target: https://github.com/akaihola/darker/blob/master/LICENSE.rst
.. |pypi-badge| image:: https://img.shields.io/pypi/v/darker
:alt: Latest release on PyPI
:target: https://pypi.org/project/darker/
.. |downloads-badge| image:: https://pepy.tech/badge/darker
:alt: Number of downloads
:target: https://pepy.tech/project/darker
.. |black-badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Source code formatted using Black
:target: https://github.com/psf/black
.. |changelog-badge| image:: https://img.shields.io/badge/-change%20log-purple
:alt: Change log
:target: https://github.com/akaihola/darker/blob/master/CHANGES.rst

What is Darker?
===============

.. include:: ../README.rst
:start-after: What?
:end-before: Why?

Why Darker?
===========

.. include:: ../README.rst
:start-after: Why?
:end-before: How?

How Does Darker Work?
=====================

.. include:: ../README.rst
:start-after: How?
:end-before: Example

Examples
========

.. include:: ../README.rst
:start-after: Example
:end-before: Customizing ``darker``

Customizing Darker, Black, isort, and flynt
==========================================

.. include:: ../README.rst
:start-after: Customizing ``darker``
:end-before: Using as a pre-commit hook

GitHub Actions Integration
==========================

.. include:: ../README.rst
:start-after: GitHub Actions integration
:end-before: Syntax highlighting

Syntax Highlighting in Darker
=============================

.. include:: ../README.rst
:start-after: Syntax highlighting
:end-before: Guarding against Black compatibility breakage

Guarding Against Black Compatibility Breakage
=============================================

.. include:: ../README.rst
:start-after: Guarding against Black compatibility breakage
:end-before: How does it work?

How Darker Works
================

.. include:: ../README.rst
:start-after: How does it work?
:end-before: Limitations and work-arounds

Limitations and Work-arounds
============================

.. include:: ../README.rst
:start-after: Limitations and work-arounds
:end-before: License

License
=======

.. include:: ../README.rst
:start-after: License
:end-before: Prior art

Prior Art
=========

.. include:: ../README.rst
:start-after: Prior art
:end-before: Contributors ✨

Contributors
============

.. include:: ../README.rst
:start-after: Contributors ✨

Loading