Skip to content

Commit

Permalink
Guidance on .readthedocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
intoverflow committed Nov 28, 2021
1 parent 8d53e4a commit 936abee
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/source/project_structure.rst
Expand Up @@ -93,7 +93,7 @@ Distribution
Documentation
~~~~~~~~~~~~~

* Publish documentation on `readthedocs.org <readthedocs.org>`_.
* Publish documentation on `readthedocs.org <https://readthedocs.org>`_.


Announcements
Expand Down Expand Up @@ -127,6 +127,7 @@ The following directory hierarchy is recommended:
* :file:`examples/`
* :file:`theories/`
* :file:`.gitignore`
* :file:`.readthedocs.yaml`
* :file:`_CoqProject`
* :file:`coq-{myproject}.opam`
* :file:`Makefile`
Expand Down Expand Up @@ -229,6 +230,14 @@ It should be amended as-needed to ensure the following:
* :command:`git status` is not changed by any of the workflows supported by :file:`Makefile` (except when such changes are the purpose of the workflow).


:file:`.readthedocs.yaml`
~~~~~~~~~~~~~~~~~~~~~~~~~

*Does not apply to all projects.*

Applies only when the project documentation is hosted by `readthedocs.org <https://readthedocs.org>`_.


:file:`_CoqProject`
~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 936abee

Please sign in to comment.