diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..d0d0d34c --- /dev/null +++ b/.readthedocs.yaml @@ -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: . diff --git a/docs/conf.py b/docs/conf.py index 1a287338..35622df2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/contributing.rst b/docs/contributing.rst index 5b190804..37e16fce 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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 --------------- @@ -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/ diff --git a/docs/index.rst b/docs/index.rst index 972ed926..668515c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -325,8 +325,9 @@ discussion and background. Resources --------- -* `IRC `_: - ``#pypa`` on irc.freenode.net +* `Discourse forum `_ +* `IRC `_: + ``#pypa`` on irc.libera.chat * `GitHub repository `_ * User and developer `documentation`_ * `Python Packaging User Guide`_