File tree 1 file changed +25
-0
lines changed
1 file changed +25
-0
lines changed Original file line number Diff line number Diff line change
1
+ .. post :: July 12, 2023
2
+ :tags: builders
3
+ :author: Manuel
4
+ :location: BCN
5
+ :category: Changelog
6
+
7
+ Doctools without configuration file (`conf.py ` / `mkdocs.yml `) are deprecated
8
+ =============================================================================
9
+
10
+ Historically, Read the Docs has created a ``docs/conf.py `` file for Sphinx projects
11
+ and a ``mkdocs.yml `` file for MkDocs projects that don’t provide one, to make onboarding easier.
12
+ This has been confusing a lot our users in different ways and
13
+ **we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don’t have one on August 28th **.
14
+ To avoid unexpected behavior or your documentation builds failing,
15
+ you should add a configuration file to your project by this date.
16
+
17
+ You can find a good example of a basic configuration file in our :doc: `example projects <readthedocs:examples >`:
18
+
19
+ * Sphinx `example conf.py <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/conf.py >`_
20
+ * Mkdocs `example mkdocs.yml <https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/mkdocs.yml `_
21
+
22
+
23
+ Please, `contact us `_ and let us know any inconvenient you may have with this change.
24
+
25
+ .. _
contact us :
mailto:[email protected]
You can’t perform that action at this time.
0 commit comments