Skip to content

Commit

Permalink
Fix the Docs (#767)
Browse files Browse the repository at this point in the history
* Add Read the Docs config file

* Replace Freenode with Libera.Chat

* Link to Discourse forum
  • Loading branch information
bhrutledge authored Jun 18, 2021
1 parent 3163fd0 commit 30090d3
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 6 deletions.
21 changes: 21 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
configuration: docs/conf.py
fail_on_warning: true

formats:
- htmlzip
- pdf
- epub

python:
version: 3.8
install:
- requirements: docs/requirements.txt
- method: pip
path: .
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,8 @@
# Avoid errors due to GitHub rate limit
# https://github.com/sphinx-doc/sphinx/issues/7388
"https://github.com/pypa/twine/issues/*",
# Avoid errors from channels interpreted as anchors
"https://web.libera.chat/#",
]

# Example configuration for intersphinx: refer to the Python standard library.
Expand Down
10 changes: 6 additions & 4 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Contributing
We are happy you have decided to contribute to twine.

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

Getting started
---------------
Expand Down Expand Up @@ -255,7 +256,8 @@ merge into a single tool; see `ongoing discussion

.. _`official Python Packaging User Guide`: https://packaging.python.org/tutorials/distributing-packages/
.. _`the GitHub repository`: https://github.com/pypa/twine
.. _`on Freenode`: https://webchat.freenode.net/?channels=%23pypa-dev,pypa
.. _`Python Packaging Discourse forum`: https://discuss.python.org/c/packaging/
.. _`IRC`: https://web.libera.chat/#pypa-dev,#pypa
.. _`distutils-sig mailing list`: https://mail.python.org/mailman3/lists/distutils-sig.python.org/
.. _`virtual environment`: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
.. _`tox`: https://tox.readthedocs.io/
Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,9 @@ discussion and background.
Resources
---------

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

0 comments on commit 30090d3

Please sign in to comment.