<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-setuptools-git.git/docs/conf.py, branch bugfix/3525-error</title>
<subtitle>github.com: pypa/setuptools.git
</subtitle>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/'/>
<entry>
<title>docs: Silence sphinx errors for reference it cannot find</title>
<updated>2022-08-06T18:39:55+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-08-06T18:27:26+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=d138ec08efc2dbaebb8752e215e324f38bd807a2'/>
<id>d138ec08efc2dbaebb8752e215e324f38bd807a2</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Merge branch 'main' into docs-notfound-page</title>
<updated>2022-08-01T16:32:58+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-08-01T16:32:58+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=00eaec7a0c4e49af9c4062145c969f08d2953abe'/>
<id>00eaec7a0c4e49af9c4062145c969f08d2953abe</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Docs: create nice 404 pages</title>
<updated>2022-07-13T10:46:48+00:00</updated>
<author>
<name>Manuel Kaufmann</name>
<email>humitos@gmail.com</email>
</author>
<published>2022-07-11T16:32:50+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=fe6d794adea937f08146084495d0721a375d8ce7'/>
<id>fe6d794adea937f08146084495d0721a375d8ce7</id>
<content type='text'>
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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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.
</pre>
</div>
</content>
</entry>
<entry>
<title>Docs: enable tooltips on documentation</title>
<updated>2022-07-13T10:31:48+00:00</updated>
<author>
<name>Manuel Kaufmann</name>
<email>humitos@gmail.com</email>
</author>
<published>2022-07-11T16:26:19+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=2d2fe2ea26463e7d8f8f862695d646f14486bfdc'/>
<id>2d2fe2ea26463e7d8f8f862695d646f14486bfdc</id>
<content type='text'>
Install the Sphinx extension `sphinx-hoverxref` to enable tooltips when hovering
internal and external references (via intersphinx).
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Install the Sphinx extension `sphinx-hoverxref` to enable tooltips when hovering
internal and external references (via intersphinx).
</pre>
</div>
</content>
</entry>
<entry>
<title>Centralize intersphinx_mapping config for docs</title>
<updated>2022-06-16T13:56:51+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-06-16T13:56:51+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=2a0ca7a81e35891dd6bcd3485d4de60148274cba'/>
<id>2a0ca7a81e35891dd6bcd3485d4de60148274cba</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Update quickstart to make it more streamline</title>
<updated>2022-06-15T17:51:23+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-06-15T17:51:23+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=6bd10b2cc1981174275c9e6a12e6808454d82a77'/>
<id>6bd10b2cc1981174275c9e6a12e6808454d82a77</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Merge docs on deprecated commands</title>
<updated>2022-06-14T14:02:38+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-06-14T14:00:38+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=6850040693db9e3edc4238c1fa4aa458aacaaa9b'/>
<id>6850040693db9e3edc4238c1fa4aa458aacaaa9b</id>
<content type='text'>
Also add a not about modern ways of generating ``sdists`` and ``wheel``.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Also add a not about modern ways of generating ``sdists`` and ``wheel``.
</pre>
</div>
</content>
</entry>
<entry>
<title>Doc improvements (#3363, #3364, #3367)</title>
<updated>2022-06-13T08:45:07+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-06-13T08:45:07+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=43b515b7b5f27ac2aad70d93320f49478782deed'/>
<id>43b515b7b5f27ac2aad70d93320f49478782deed</id>
<content type='text'>
- Improve docs by avoiding confusion with distutils
- Update dependency management docs
- Update userguide on miscellaneous and extension
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
- Improve docs by avoiding confusion with distutils
- Update dependency management docs
- Update userguide on miscellaneous and extension
</pre>
</div>
</content>
</entry>
<entry>
<title>Merge https://github.com/jaraco/skeleton</title>
<updated>2022-06-12T20:35:53+00:00</updated>
<author>
<name>Jason R. Coombs</name>
<email>jaraco@jaraco.com</email>
</author>
<published>2022-06-12T20:17:39+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=66ad7781db135ebd7965716dd1a6fcd8ef503f9a'/>
<id>66ad7781db135ebd7965716dd1a6fcd8ef503f9a</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Improve docs by avoiding confusion with distutils</title>
<updated>2022-06-12T11:59:01+00:00</updated>
<author>
<name>Anderson Bravalheri</name>
<email>andersonbravalheri@gmail.com</email>
</author>
<published>2022-06-12T11:32:31+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/python-setuptools-git.git/commit/?id=8e72d24832c9c94108e404d368ee09685630cbe8'/>
<id>8e72d24832c9c94108e404d368ee09685630cbe8</id>
<content type='text'>
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`
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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`
</pre>
</div>
</content>
</entry>
</feed>
