summaryrefslogtreecommitdiff
path: root/docs/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* docs: Silence sphinx errors for reference it cannot findAnderson Bravalheri2022-08-061-0/+1
|
* Merge branch 'main' into docs-notfound-pageAnderson Bravalheri2022-08-011-0/+13
|\
| * Docs: enable tooltips on documentationManuel Kaufmann2022-07-131-0/+13
| | | | | | | | | | Install the Sphinx extension `sphinx-hoverxref` to enable tooltips when hovering internal and external references (via intersphinx).
* | Docs: create nice 404 pagesManuel Kaufmann2022-07-131-0/+3
|/ | | | | | | | | Currently, when a user arrives at a 404 page, Read the Docs shows the default Maze Found page without context about the setuptools project itself. This extension, `sphinx-notfound-page`, creates a `404.html` page with the same style as the rest of the documentation pages that Read the Docs will serve instead of the default Maze Found one.
* Centralize intersphinx_mapping config for docsAnderson Bravalheri2022-06-161-9/+8
|
* Update quickstart to make it more streamlineAnderson Bravalheri2022-06-151-0/+1
|
* Merge docs on deprecated commandsAnderson Bravalheri2022-06-141-0/+1
| | | | Also add a not about modern ways of generating ``sdists`` and ``wheel``.
*-. Doc improvements (#3363, #3364, #3367)Anderson Bravalheri2022-06-131-1/+0
|\ \ | | | | | | | | | | | | | | | - Improve docs by avoiding confusion with distutils - Update dependency management docs - Update userguide on miscellaneous and extension
| * | Improve docs by avoiding confusion with distutilsAnderson Bravalheri2022-06-121-1/+0
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing docs seem to assume that the user is familiar with the history of packaging in the Python ecosystem (or at least know what is `distutils`). Since that is not always the case and that `distutils` is in the process of being adopted by `setuptools`, the documentation should be changed to minimize mentions to `distutils` and avoid expecting too much knowledge from the users. The benefit of this approach is that it can make the docs more accessible and easier to understand. Changes: - Modify landing page to clarify what `setuptools` does (making it more clear to understand for beginners). - Remove mentions to `distutils`, `transition to PEP 517` from `userguide/index`. - Instead the text is changed to have a more "introductory" tone. - Remove mentions to `distutils` from the Quickstart. - Remove `python2` from the intersphinx mapping - it was causing trouble redirecting glossary terms to Python2 docs, instead of Python3. - Modify documentation about development mode to be more aligned with current practices (i.e. using `pip install -e .`) - In this process all documentation about running `setuptools` commands in `distutils` projects was moved to a new file in `docs/deprecated/running_commands.rst`
* | Merge https://github.com/jaraco/skeletonJason R. Coombs2022-06-121-12/+12
|\ \ | |/ |/|
| * Update base URL for PEPs (#61)Hugo van Kemenade2022-06-041-1/+1
| |
* | Fixed caption string of 'user' entry in `extlinks`Saniya Maheshwari2022-06-081-1/+1
| | | | | | | | | | | | `extlinks` seems to have recently started emitting the following warning requiring the caption string to contain exactly one `%s`. This warning also stops the docs from building locally.
* | Move userguide/keywords to deprecated/changed_keyworkdsAnderson Bravalheri2022-05-061-0/+6
| |
* | Avoid extlink for issue to prevent verbose warningsAnderson Bravalheri2022-03-241-2/+4
| |
* | Specify Python 3 after Python 2 in intersphinx mappingAnderson Bravalheri2022-03-241-1/+1
| | | | | | | | Hopefully it will make links to Python 3 the default.
* | Add initial docs about pyproject.toml metadataAnderson Bravalheri2022-03-161-0/+1
| |
* | Merge branch 'main' into experimental/support-pyprojectAnderson Bravalheri2022-03-161-0/+1
|\ \
| * | Link packagingAnderson Bravalheri2022-03-131-0/+1
| | |
* | | Add news fragmentAnderson Bravalheri2022-03-051-1/+7
|/ /
* | Clarify the relationship between wheel <> sdistAnderson Bravalheri2022-03-041-0/+1
| |
* | Modify datafiles docs to emphasize importlib.resources over pkg_resoruecesAnderson Bravalheri2022-03-031-0/+3
| |
* | Improve regex for autolinking PEPs on changelogAnderson Bravalheri2022-02-191-1/+1
| |
* | Extend matching of issue/commit links to all PyPA repositoriesAnderson Bravalheri2022-02-191-4/+4
| | | | | | | | | | | | Currently the link for the pypa/get-pip issue was rendering wrongly. This change extends the matching for issues and commits (currently only handling `distutils`) to any PyPA repository.
* | Avoid accidental URL replacement in CHANGELOGAnderson Bravalheri2022-02-191-1/+1
| | | | | | | | | | Use negative look-behind regex on docs/conf.py to improve `issues` URL matching.
* | Merge pull request #2897 from abravalheri/improve-docsJason R. Coombs2022-01-301-0/+1
|\ \ | | | | | | Docs: Add instructions about `build_meta` wrappers as alternative to dynamic `setup_requires`
| * | Add documentation about build_meta wrappersAnderson Bravalheri2021-11-191-0/+1
| | |
* | | Remove unused imports from docs/conf.pyAnderson Bravalheri2022-01-061-3/+0
| | |
* | | Replace in-tree sphinx extension with sphinx-faviconAnderson Bravalheri2022-01-061-7/+6
| | | | | | | | | | | | | | | | | | | | | | | | This change has been previously proposed and agreed upon in #2869. The idea here is to avoid the burden of maintaining an in-tree sphinx extension, now that `sphinx-favicon` is available and covers setuptools use-case.
* | | 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.
View Lorry Controller Status