Skip to content

Commit c23b42c

Browse files
committed
docs: let's use the Read the Docs theme for Sphinx again
1 parent b46ddbd commit c23b42c

File tree

5 files changed

+11
-303
lines changed

5 files changed

+11
-303
lines changed

.github/workflows/doc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Setup and build
1717
run: |
1818
sudo apt-get install python3-pip
19-
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme furo GitPython
19+
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme GitPython
2020
mkdir public
2121
mkdir public/html
2222
cp doc/source/index.html public/html/

.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ pages:
1616
- apk add git
1717
- pip install -U GitPython
1818
- pip install -U sphinx
19-
- pip install -U furo
19+
- pip install -U sphinx-rtd-theme
2020
- pip install -U sphinx-vhdl
2121
- echo "Hotfix detached head, causing trouble in GitPython:"
2222
- git checkout $CI_COMMIT_BRANCH

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ First, you need to install a few Python packages:
6060
$ pip3 install --user GitPython
6161
$ pip3 install --user sphinx
6262
$ pip3 install --user sphinx-vhdl
63-
$ pip3 install --user furo
63+
$ pip3 install --user sphinx-rtd-theme
6464
```
6565

6666
Then the documentation is generated simply by issuing these two commands:

doc/source/_templates/page.html

Lines changed: 0 additions & 297 deletions
This file was deleted.

doc/source/conf.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,13 @@
5050
# The theme to use for HTML and HTML Help pages. See the documentation for
5151
# a list of builtin themes.
5252
#
53-
html_theme = 'furo'
53+
html_theme = 'sphinx_rtd_theme'
5454
html_theme_options = {
55-
"globaltoc_maxdepth": 4,
56-
"banner_hiding": "permanent",
55+
'collapse_navigation': True,
56+
'sticky_navigation': True,
57+
'navigation_depth': 4,
58+
'includehidden': True,
59+
'display_version': True,
5760
}
5861

5962
html_logo = "img/ndk_fpga_logo_simple.png"
@@ -62,3 +65,5 @@
6265
# relative to this directory. They are copied after the builtin static files,
6366
# so a file named "default.css" will overwrite the builtin "default.css".
6467
html_static_path = ['_static']
68+
69+
html_style = 'css/theme_overrides.css'

0 commit comments

Comments
 (0)