Skip to content

Commit 30090d3

Browse files
authored
Fix the Docs (#767)
* Add Read the Docs config file * Replace Freenode with Libera.Chat * Link to Discourse forum
1 parent 3163fd0 commit 30090d3

File tree

4 files changed

+32
-6
lines changed

4 files changed

+32
-6
lines changed

.readthedocs.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
version: 2
6+
7+
sphinx:
8+
configuration: docs/conf.py
9+
fail_on_warning: true
10+
11+
formats:
12+
- htmlzip
13+
- pdf
14+
- epub
15+
16+
python:
17+
version: 3.8
18+
install:
19+
- requirements: docs/requirements.txt
20+
- method: pip
21+
path: .

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@
269269
# Avoid errors due to GitHub rate limit
270270
# https://github.com/sphinx-doc/sphinx/issues/7388
271271
"https://github.com/pypa/twine/issues/*",
272+
# Avoid errors from channels interpreted as anchors
273+
"https://web.libera.chat/#",
272274
]
273275

274276
# Example configuration for intersphinx: refer to the Python standard library.

docs/contributing.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ Contributing
44
We are happy you have decided to contribute to twine.
55

66
Please see `the GitHub repository`_ for code and more documentation,
7-
and the `official Python Packaging User Guide`_ for user documentation. You can
8-
also join ``#pypa`` or ``#pypa-dev`` `on Freenode`_, or the `distutils-sig
9-
mailing list`_, to ask questions or get involved.
7+
and the `official Python Packaging User Guide`_ for user documentation.
8+
To ask questions or get involved, you can join the `Python Packaging
9+
Discourse forum`_, ``#pypa`` or ``#pypa-dev`` on `IRC`_, or the
10+
`distutils-sig mailing list`_.
1011

1112
Getting started
1213
---------------
@@ -255,7 +256,8 @@ merge into a single tool; see `ongoing discussion
255256

256257
.. _`official Python Packaging User Guide`: https://packaging.python.org/tutorials/distributing-packages/
257258
.. _`the GitHub repository`: https://github.com/pypa/twine
258-
.. _`on Freenode`: https://webchat.freenode.net/?channels=%23pypa-dev,pypa
259+
.. _`Python Packaging Discourse forum`: https://discuss.python.org/c/packaging/
260+
.. _`IRC`: https://web.libera.chat/#pypa-dev,#pypa
259261
.. _`distutils-sig mailing list`: https://mail.python.org/mailman3/lists/distutils-sig.python.org/
260262
.. _`virtual environment`: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
261263
.. _`tox`: https://tox.readthedocs.io/

docs/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,9 @@ discussion and background.
325325
Resources
326326
---------
327327

328-
* `IRC <https://webchat.freenode.net/?channels=%23pypa>`_:
329-
``#pypa`` on irc.freenode.net
328+
* `Discourse forum <https://discuss.python.org/c/packaging/>`_
329+
* `IRC <https://web.libera.chat/#pypa>`_:
330+
``#pypa`` on irc.libera.chat
330331
* `GitHub repository <https://github.com/pypa/twine>`_
331332
* User and developer `documentation`_
332333
* `Python Packaging User Guide`_

0 commit comments

Comments
 (0)