Skip to content

Commit

Permalink
docs: let's use the Read the Docs theme for Sphinx again
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubcabal committed Nov 19, 2024
1 parent b46ddbd commit c23b42c
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 303 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup and build
run: |
sudo apt-get install python3-pip
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme furo GitPython
pip3 install sphinx sphinx-vhdl sphinx_rtd_theme GitPython
mkdir public
mkdir public/html
cp doc/source/index.html public/html/
Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pages:
- apk add git
- pip install -U GitPython
- pip install -U sphinx
- pip install -U furo
- pip install -U sphinx-rtd-theme
- pip install -U sphinx-vhdl
- echo "Hotfix detached head, causing trouble in GitPython:"
- git checkout $CI_COMMIT_BRANCH
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ First, you need to install a few Python packages:
$ pip3 install --user GitPython
$ pip3 install --user sphinx
$ pip3 install --user sphinx-vhdl
$ pip3 install --user furo
$ pip3 install --user sphinx-rtd-theme
```

Then the documentation is generated simply by issuing these two commands:
Expand Down
297 changes: 0 additions & 297 deletions doc/source/_templates/page.html

This file was deleted.

11 changes: 8 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,13 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
"globaltoc_maxdepth": 4,
"banner_hiding": "permanent",
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'display_version': True,
}

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

html_style = 'css/theme_overrides.css'

0 comments on commit c23b42c

Please sign in to comment.