Skip to content

Commit aee3f49

Browse files
authored
Docs: make sphinx.configuration in the tutorial (#10718)
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
1 parent 0c1df75 commit aee3f49

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/user/tutorial/index.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,9 @@ and change the Python version as follows:
330330
install:
331331
- requirements: docs/requirements.txt
332332
333+
sphinx:
334+
configuration: docs/source/conf.py
335+
333336
The purpose of each key is:
334337

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

444448
.. code-block:: yaml
445449
:caption: .readthedocs.yaml
446-
:emphasize-lines: 4-6
450+
:emphasize-lines: 5-7
447451
448452
sphinx:
453+
configuration: docs/source/conf.py
449454
fail_on_warning: true
450455
451456
formats:

0 commit comments

Comments
 (0)