Skip to content

Commit

Permalink
docs(rtd): update python version
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed Dec 31, 2024
1 parent 3e9072c commit a8ed1e2
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
version: 2

build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.9"
python: "3.12"

sphinx:
configuration: docs/api/source/conf.py
Expand Down
6 changes: 5 additions & 1 deletion docs/api/local_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,8 @@ mkdir dist

# Build and open
sphinx-build source dist
google-chrome ./dist/index.html
# rm -rf _build/doctrees
# python -m sphinx -T -b html -d _build/doctrees -D language=en source dist

cd dist
python -m http.server 8000
5 changes: 2 additions & 3 deletions docs/api/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
--extra-index-url https://wheels.vtk.org
vtk==9.3.20240817.dev0
vtk==9.4.1

pygments
sphinx
sphinx-rtd-theme
sphinx_rtd_theme

# Add external widgets

Expand Down
21 changes: 21 additions & 0 deletions docs/api/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,27 @@

HTML_ELEMENT_REGEX = re.compile(r"^trame.*\.widgets\..*HtmlElement$")

# -- Theme configuration -----------------------------------------------------

# html_theme_options = {
# 'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
# 'analytics_anonymize_ip': False,
# 'logo_only': False,
# 'prev_next_buttons_location': 'bottom',
# 'style_external_links': False,
# 'vcs_pageview_mode': '',
# 'style_nav_header_background': 'white',
# 'flyout_display': 'hidden',
# 'version_selector': True,
# 'language_selector': True,
# # Toc options
# 'collapse_navigation': True,
# 'sticky_navigation': True,
# 'navigation_depth': 4,
# 'includehidden': True,
# 'titles_only': False
# }

# -- Project information -----------------------------------------------------

project = "Trame"
Expand Down
2 changes: 2 additions & 0 deletions docs/api/source/tools.monitor.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Resource Monitor with Launcher
====================================

Expand Down

0 comments on commit a8ed1e2

Please sign in to comment.