Skip to content

Commit ffe9493

Browse files
authored
patch documentation website (#25)
* Update conf.py * yml now consistent with sphinx_rtd_theme * Update requirements.txt docs/requirements consistent with sphinx_rtd_theme * add back sphinx-rtd-theme to docs/requirements.txt * trimmed index * very simple index * add title
1 parent 8ece38b commit ffe9493

4 files changed

Lines changed: 11 additions & 10 deletions

File tree

.readthedocs.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ formats: all
99

1010
# Set the version of Python and other tools you might need
1111
build:
12-
os: ubuntu-22.04
12+
os: "ubuntu-22.04"
1313
tools:
14-
python: "3.9"
14+
python: "3.10"
1515

1616
# Build documentation in the docs/ directory with Sphinx
1717
sphinx:
@@ -20,3 +20,5 @@ sphinx:
2020
python:
2121
install:
2222
- requirements: docs/requirements.txt
23+
- method: pip
24+
path: .

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
sphinx-rtd-theme
1+
sphinx>=7.1,<7.2
2+
sphinx-rtd-theme>=2.0

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
'sphinx.ext.napoleon',
4444
'sphinx.ext.mathjax',
4545
'sphinx.ext.viewcode',
46+
'sphinx_rtd_theme',
4647
]
4748

4849
# Suppress "WARNING: unknown mimetype for ..."

docs/source/index.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
.. AABBTree documentation master file.
1+
=================
2+
Introduction
3+
=================
24

3-
.. include:: ../../README.rst
4-
:end-before: .. begin-introduction
5-
6-
7-
.. include:: contents.rst
8-
:start-after: .. Introduction
5+
Hello World!

0 commit comments

Comments
 (0)