diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ef9ddc6..2046e3d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,12 +5,16 @@ # Required version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # Optionally set the version of Python and requirements required to build your docs python: - version: 3.8 install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 4324663..77ed362 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,8 +52,8 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -# html_theme = 'alabaster' html_theme = 'sphinx_rtd_theme' + # html_theme_options = { # 'analytics_id': 'G-CH3JS5076R', # Provided by Google in your dashboard # 'analytics_anonymize_ip': False, @@ -74,3 +74,8 @@ # 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'] +# python3 -m sphinx.ext.intersphinx https://docs.python-requests.org/en/master/objects.inv +intersphinx_mapping = { + 'requests': ('https://docs.python-requests.org/en/master/', None), + 'python': ('https://docs.python.org/3', None) +} diff --git a/docs/requirements.txt b/docs/requirements.txt index 4f61efd..fd49df5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,8 @@ -sphinx==3.5.4 +sphinx==5.1.1 sphinxcontrib-bibtex sphinx-copybutton pandas pynmrstar>=3.0.4 plotly>=4.5.4 -numpy>=1.15.0 \ No newline at end of file +numpy>=1.15.0 +sphinx_rtd_theme