Skip to content

Commit 6bc66a1

Browse files
authored
Update readthedocs configuration (#93)
* update readthedocs python version * add sphinx_rtd_theme requirement * add sphinx.ext.napoleon * remove html_static_path * rename sphinx project * update sphinx index
1 parent c47cfc3 commit 6bc66a1

4 files changed

Lines changed: 8 additions & 6 deletions

File tree

.readthedocs.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ version: 2
77

88
# Set the version of Python and other tools you might need
99
build:
10-
os: ubuntu-22.04
10+
os: "ubuntu-22.04"
1111
tools:
12-
python: "3.10"
12+
python: "3.11"
1313
# You can also specify other tool versions:
1414
# nodejs: "19"
1515
# rust: "1.64"

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
sphinx_mdinclude
2+
sphinx_rtd_theme

docs/source/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = "e3dc"
9+
project = "python-e3dc"
1010
copyright = "2023, see AUTHORS file"
1111
author = "see AUTHORS file"
1212

@@ -20,6 +20,7 @@
2020
"sphinx.ext.autodoc",
2121
"sphinx_rtd_theme",
2222
"sphinx_mdinclude",
23+
"sphinx.ext.napoleon",
2324
]
2425

2526
templates_path = ["_templates"]
@@ -31,7 +32,7 @@
3132
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3233

3334
html_theme = "sphinx_rtd_theme"
34-
html_static_path = ["_static"]
35+
# html_static_path = ["_static"]
3536

3637
# -- Options for todo extension ----------------------------------------------
3738
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. e3dc documentation master file, created by
1+
.. python-e3dc documentation master file, created by
22
sphinx-quickstart on Sat Feb 11 10:32:00 2023.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to e3dc's documentation!
6+
Welcome to python-e3dc's documentation!
77
================================
88

99
.. mdinclude:: ../../README.md

0 commit comments

Comments
 (0)