Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hczhai committed Oct 6, 2023
1 parent 9a42432 commit fa1b2c6
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 14 deletions.
17 changes: 17 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
configuration: docs/source/conf.py

formats:
- pdf
- epub

python:
install:
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==5.3.0
sphinx-rtd-theme==1.2.0
sphinx-rtd-theme==1.3.0
nbsphinx==0.8.12
jinja2==3.1.2
18 changes: 5 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax'
'sphinx.ext.mathjax',
'sphinx_rtd_theme',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -44,18 +45,9 @@


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
on_rtd = os.environ.get('READTHEDOCS') == 'True'
if on_rtd:
html_theme = 'default'
autodoc_mock_imports = ['block3', 'numpy', 'psutil']
else:
html_theme = 'bizstyle'
sys.path.insert(0, os.path.abspath('../../build'))

html_theme = 'sphinx_rtd_theme'
autodoc_mock_imports = ['block3', 'numpy', 'psutil']
sys.path.insert(0, os.path.abspath('../../build'))
sys.path.insert(0, os.path.abspath('../..'))

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down

0 comments on commit fa1b2c6

Please sign in to comment.