Skip to content

Commit

Permalink
Fix readthedocs building (#47)
Browse files Browse the repository at this point in the history
* Revert "Fix docs theme issue"

This reverts commit 7a4c702.

* Add install requirements for build
  • Loading branch information
mguerret-amd committed Dec 7, 2023
1 parent 7a4c702 commit 14c2233
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Defining requirements for docs
sphinx==5.3.0
sphinx_rtd_theme==1.1.1
readthedocs-sphinx-search==0.1.1
8 changes: 4 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@

# import sphinx_rtd_theme for retrieving theme
# path from module
# import sphinx_rtd_theme
import sphinx_rtd_theme

# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = 'sphinx_rtd_theme'
# html_theme = 'alabaster'
html_theme = 'classic'
# html_theme = 'classic'
# html_theme = 'sphinxdoc'
# html_theme = 'scrolls'
# html_theme = 'agogo'
Expand Down
9 changes: 4 additions & 5 deletions readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ build:
sphinx:
configuration: docs/source/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
# Explicitly set the version of Python and its requirements
python:
install:
- requirements: docs/requirements.txt

0 comments on commit 14c2233

Please sign in to comment.