Skip to content

Commit

Permalink
Docs: make sphinx.configuration in the tutorial (#10718)
Browse files Browse the repository at this point in the history
There are some users having problems with this.
It's better to make this config key explicit.
Besides, we will eventually deprecate the "auto-find" the `conf.py` file.

Follows readthedocs/tutorial-template#53
  • Loading branch information
humitos authored Sep 12, 2023
1 parent 0c1df75 commit aee3f49
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/user/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,9 @@ and change the Python version as follows:
install:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/source/conf.py
The purpose of each key is:

``version``
Expand Down Expand Up @@ -401,6 +404,7 @@ click on the |:pencil2:| icon, and add these contents:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/source/conf.py
fail_on_warning: true
At this point, if you navigate back to your "Builds" page,
Expand Down Expand Up @@ -443,9 +447,10 @@ To do so, add this extra content to your ``.readthedocs.yaml``:

.. code-block:: yaml
:caption: .readthedocs.yaml
:emphasize-lines: 4-6
:emphasize-lines: 5-7
sphinx:
configuration: docs/source/conf.py
fail_on_warning: true
formats:
Expand Down

0 comments on commit aee3f49

Please sign in to comment.