-
Notifications
You must be signed in to change notification settings - Fork 57
create base for readthedocs sphinx site #764
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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'] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
akaihola marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .. |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? | ||
akaihola marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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 ✨ | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.