Skip to content

Commit

Permalink
Add documentation for readthedocs support. (#212)
Browse files Browse the repository at this point in the history
Co-authored-by: Jens Vagelpohl <[email protected]>
  • Loading branch information
Michael Howitz and dataflake authored Oct 5, 2023
1 parent ca45ff1 commit 4a6085d
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions config/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,12 @@ Each directory contains the following files if they differ from the default
- Configuration file for the MANIFEST to include all needed files in sdist
and wheel.

* setup.cfg
* readthedocs.yaml.j2

- Configuration for https://readthedocs.org to build the documentation over
there if the package has documentation.

* setup.cfg.j2

- common setup.cfg, which should be copied to the repository of the
package
Expand Down Expand Up @@ -106,8 +111,8 @@ The script does the following steps:

1. Add the package name to ``packages.txt`` of the selected configuration type
if it is not yet added.
2. Copy ``setup.cfg``, ``tox.ini``, ``tests.yml``, ``MANIFEST.in`` and
``.gitignore`` to the repository.
2. Copy ``setup.cfg``, ``tox.ini``, ``tests.yml``, ``MANIFEST.in``,
``.readthedocs.yaml`` (if needed), and ``.gitignore`` to the repository.
3. Remove a possibly existing ``.coveragerc`` and ``bootstrap.py``. (Coverage
is now configured in ``tox.ini`` for packages which are no buildout
recipes.)
Expand Down Expand Up @@ -170,7 +175,9 @@ The following options are only needed one time as their values are stored in
packages.

--with-docs
Enable building the documentation using Sphinx.
Enable building the documentation using Sphinx. This will also create a
configuration file `.readthedocs.yaml` for integration with
https://readthedocs.org.

--with-sphinx-doctests
Enable running the documentation as doctest using Sphinx.
Expand Down

0 comments on commit 4a6085d

Please sign in to comment.