Skip to content

Commit 5988d40

Browse files
committed
The changes made in this commit include:
- Added `sphinx-rtd-theme` to the `Pipfile` to use the Read the Docs theme for Sphinx documentation. - Modified `conf.py` to set the HTML theme to `sphinx_rtd_theme` for the Sphinx documentation. - Modified `settings.py` to add the `DOCS_ROOT` variable to specify the root directory for the Django documentation.
1 parent 0c669cc commit 5988d40

File tree

4 files changed

+27
-7
lines changed

4 files changed

+27
-7
lines changed

Pipfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ pyparsing = "*"
3131
pydot = "*"
3232
django-docs = "*"
3333
sphinxcontrib-django = "*"
34+
sphinx-rtd-theme = "*"
3435

3536
[dev-packages]
3637
flake8 = "*"

Pipfile.lock

Lines changed: 21 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/docs/source/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,5 @@
3232
# -- Options for HTML output -------------------------------------------------
3333
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3434

35-
# html_theme = "sphinx_rtd_theme"
36-
html_theme = 'alabaster'
35+
html_theme = "sphinx_rtd_theme"
3736
html_static_path = ['_static']

src/signal_documentation/settings.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,3 +217,7 @@
217217
'app_labels': ["datasources"],
218218
'group_models': True,
219219
}
220+
221+
# django docs
222+
# https://django-docs.readthedocs.io/en/latest/
223+
DOCS_ROOT = os.path.join(BASE_DIR, 'docs', 'build', 'html')

0 commit comments

Comments
 (0)