summaryrefslogtreecommitdiff
path: root/docs/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Render distutils commit links properly in docsAlex Hedges2021-12-191-0/+4
|
* Merge branch 'main' into prefer-svg-imagesJason R. Coombs2021-11-121-0/+2
|\
| * Document that pip works with editable setup.cfgSviatoslav Sydorenko2021-11-111-0/+2
| |
* | Add SVG favicons via custom Sphinx extensionAnderson Bravalheri2021-11-101-2/+27
|/
* Add favicon and related configuration to sphinxAnderson Bravalheri2021-11-051-0/+1
|
* Add docs/README to the toctreeAnderson Bravalheri2021-11-041-1/+0
|
* Rename logo filesAnderson Bravalheri2021-11-041-3/+2
|
* Customise the sphinx theme to reflect the new logoAnderson Bravalheri2021-11-041-0/+15
|
* Merge https://github.com/jaraco/skeletonJason R. Coombs2021-10-311-2/+9
|\
| * Add intersphinx mappings for Python to prevent spurious nitpicky failures. ↵Jason R. Coombs2021-09-171-0/+7
| | | | | | | | Fixes jaraco/skeleton#51.
* | Merge branch 'main' into change-docs-themeJason R. Coombs2021-07-181-19/+62
|\ \
| * \ Merge https://github.com/jaraco/tideliftJason R. Coombs2021-07-181-5/+2
| |\ \
| | * | Implement tidelift banner using a Sphinx directive implemented by ↵Jason R. Coombs2021-07-181-5/+1
| | | | | | | | | | | | | | | | jaraco.tidelift.
| * | | Avoid publishing unreleased changes when there are none.Jason R. Coombs2021-05-191-0/+2
| | | |
| * | | Remove seemingly unneeded settings.Jason R. Coombs2021-05-091-13/+2
| | | |
| * | | Display changelog for unreleased version in docsSviatoslav Sydorenko2021-05-051-0/+16
| | | |
| * | | Merge https://github.com/jaraco/skeletonJason R. Coombs2021-05-041-3/+3
| |\ \ \ | | | |/ | | |/|
| | * | Make sphinx fail on any warnings (#36)Sviatoslav Sydorenko2021-04-251-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds `nitpicky=True` (which is an equivalent of `-n`) to make Sphinx emit warnings for any references to non-existing targets. Then, it adds `-W` to make it fail whenever a single warning is seen. Finally, `--keep-going` allows Sphinx to print out all the warnings before exiting instead of showing just one and bailing. Resolves #29 Refs: * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-n * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
| * | | Fix doc builds for intersphinx mapping. Supersedes #2659.Jason R. Coombs2021-05-041-4/+4
| | | |
| * | | Merge branch 'main' into feature/distutils-docsJason R. Coombs2021-04-251-83/+27
| |\ \ \
| | * \ \ Merge pull request #2584 from amy-lei/tabbed-codeJason R. Coombs2021-03-051-0/+3
| | |\ \ \ | | | | | | | | | | | | Add mechanism for comparison of setup.py and its equivalent setup.cfg
| | | * | | Extend extensions later in the file. Fixes flake8 failure and isolates the ↵Jason R. Coombs2021-03-051-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | (sole) change from other concerns.
| | | * | | Add sphinx-inline-tabs extensionAmy2021-02-281-1/+1
| | | | | |
| | * | | | quickstart: recommend PyPA build instead of pep517.buildAndrey Bienkowski2021-02-091-1/+4
| | |/ / / | | | | | | | | | | | | | | | see https://github.com/pypa/pep517/issues/91
| | * | | Remove bootstrap from docs buildJason R. Coombs2021-01-191-16/+0
| | | | |
| * | | | Allow some refs to undocumented/undeclared objectsSviatoslav Sydorenko2020-10-191-0/+36
| | | | |
| * | | | Enable intersphinx to link against CPython docsSviatoslav Sydorenko2020-10-191-0/+8
| | | | |
* | | | | Change documentation theme to FuroPradyun Gedam2020-12-281-4/+2
| |/ / / |/| | |
* | | | Merge https://github.com/jaraco/tidelift into mainJason R. Coombs2020-12-201-0/+5
|\ \ \ \ | | |_|/ | |/| |
| * | | List sidebars to avoid errors looking for template 't'Jason R. Coombs2019-09-091-1/+1
| | | |
| * | | Rely on alabaster theme to support sidebar rendering.Jason R. Coombs2019-01-261-0/+1
| | | |
| * | | Add Tidelift templateJason R. Coombs2019-01-261-0/+4
| / /
* | | Merge https://github.com/jaraco/skeleton into feature/skeletonJason R. Coombs2020-12-121-72/+21
|\ \ \ | |/ / |/| / | |/
| * Collapse skeleton history from archive/2020-12Jason R. Coombs2020-12-081-0/+26
|
* ✨Make the default implicit role autofind targetsSviatoslav Sydorenko2020-10-161-0/+5
|
* 🚑 Make Sphinx nitpicky about broken referencesSviatoslav Sydorenko2020-10-161-0/+4
| | | | Fixes #2424
* Add a :user: role in SphinxSviatoslav Sydorenko2020-09-241-1/+15
| | | | | | | | | | This change adds a role that links to the GitHub user Sponsors page. If that page is not set up, it'll redirect to the GitHub user profile page instead: Links to https://github.com/sponsors/{{ username }} open as GitHub Sponsors page if the target `username` has it enabled and redirect to https://github.com/{{ username }} if it's disabled.
* Use canonical extension for docs.Jason R. Coombs2020-09-231-7/+0
|
* Add links for distutilsJason R. Coombs2020-09-011-0/+4
|
* Support 'bpo-' prefix on Python bugsJason R. Coombs2020-09-011-1/+1
|
* Merge branch 'master' of https://github.com/pypa/setuptoolsJason R. Coombs2020-01-191-1/+1
|\
| * Bootstrap the environment in tox, allowing simple 'tox' to run tests and ↵Jason R. Coombs2020-01-191-1/+1
| | | | | | | | simplifying all of the pipelines.
* | 👹 Feed the hobgoblins (delint).Jason R. Coombs2020-01-191-4/+4
| |
* | 👹 Feed the hobgoblins (delint).Jason R. Coombs2020-01-191-28/+11
|/
* Fixed html sidebars to supported version in Sphinx (#1804)A_Rog2019-08-131-1/+1
|
* Fix doc build warningsJeremy Bowman2018-05-141-1/+4
|
* Constrain hack to the RTD environment. Rely on bootstrap routine to make ↵Jason R. Coombs2017-03-311-5/+8
| | | | dependencies available.
* Hack must genuflect to the arbitrory invocation locationJason R. Coombs2017-03-311-1/+3
|
* Make sure bootstrap finishes before continuing, and ensure that ↵Jason R. Coombs2017-03-301-2/+2
| | | | jaraco.packaging.sphinx is run before rst.linker.
* Remove excess hackJason R. Coombs2017-03-301-1/+0
|