summaryrefslogtreecommitdiff
path: root/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Apply suggestions from code reviewAnderson Bravalheri2022-06-131-1/+1
|
* Improve docs by avoiding confusion with distutilsAnderson Bravalheri2022-06-121-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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`
* Rename `docs/{images/README => artwork}.rst`Anderson Bravalheri2022-01-061-1/+1
| | | | | | | | Unfortunately sphinx do not accept `.rst` files inside folders that are added to the `html_static_path`. (Adding `docs/images` to `html_static_path` will be required in a follow up commit to adopt the `sphinx-favicon` extension)
* Add docs/README to the toctreeAnderson Bravalheri2021-11-041-2/+9
|
* Rename logo filesAnderson Bravalheri2021-11-041-1/+1
|
* Add banner to main docs pageAnderson Bravalheri2021-11-041-2/+5
|
* Merge branch 'main' into change-docs-themeJason R. Coombs2021-07-181-0/+2
|\
| * Merge https://github.com/jaraco/tideliftJason R. Coombs2021-07-181-0/+2
| |\
| | * Implement tidelift banner using a Sphinx directive implemented by ↵Jason R. Coombs2021-07-181-0/+1
| | | | | | | | jaraco.tidelift.
* | Tweak the index page's contentsPradyun Gedam2020-12-281-4/+3
|/
* 🐛📝 Fix the TOC link to the relocated dev guideSviatoslav Sydorenko2020-10-171-1/+1
| | | | This change corrects the typo introduced by #2426.
* Merge branch 'master' into group-dev-docsJason R. Coombs2020-10-171-1/+7
|\
| * 📝 Recover interdoc links & correct broken syntaxSviatoslav Sydorenko2020-10-161-0/+5
| |
| * Recover the changelog docs page linkSviatoslav Sydorenko2020-10-161-0/+1
| | | | | | | | It's been lost as a part of https://github.com/pypa/setuptools/pull/2097
* | group development related files togetheralvy2020-10-151-1/+1
|/
* Use canonical extension for docs.Jason R. Coombs2020-09-231-0/+14