Skip to content

Commit 92c1f39

Browse files
committed
[docs] minor configuration fixes
1 parent fe83311 commit 92c1f39

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

.readthedocs.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ build:
1616
# Build documentation in the docs/ directory with Sphinx
1717
sphinx:
1818
configuration: docs/conf.py
19+
fail_on_warning: true
1920

2021
# If using Sphinx, optionally build your docs in additional formats such as PDF
2122
# formats:
2223
# - pdf
2324

2425
# Optionally declare the Python requirements required to build your docs
2526
python:
26-
install:
27-
- requirements: docs/requirements.txt
27+
install:
28+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
version = __version__
3939
release = version
4040

41+
4142
################################################################################
42-
# General configuration
43-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
43+
# Extensions
4444
################################################################################
4545

4646
extensions = [
@@ -57,11 +57,6 @@
5757
"sphinxarg.ext",
5858
]
5959

60-
templates_path = ["_templates"]
61-
exclude_patterns = ["_build", "weblinks.rst"]
62-
63-
language = "en"
64-
6560
################################################################################
6661
# Extensions Configuration
6762
################################################################################
@@ -72,6 +67,15 @@
7267
# If you don't add this, todos don't appear
7368
todo_include_todos = True
7469

70+
################################################################################
71+
# General configuration
72+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
73+
################################################################################
74+
75+
templates_path = ["_templates"]
76+
exclude_patterns = ["_build", "weblinks.rst"]
77+
language = "en"
78+
7579
################################################################################
7680
# HTML
7781
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

0 commit comments

Comments
 (0)