diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..e96b3d12e --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,24 @@ +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +version: 2 + + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +formats: all + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: requirements/docs.txt + - method: pip + path: . + extra_requirements: + - full diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 82300c6f9..000000000 --- a/readthedocs.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -version: 2 -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -formats: all - -build: - os: ubuntu-22.04 - tools: - python: "3.10" - -python: - install: - - requirements: requirements/docs.txt diff --git a/requirements/docs.in b/requirements/docs.in index bbfe5118b..58eb4813c 100644 --- a/requirements/docs.in +++ b/requirements/docs.in @@ -1,5 +1,4 @@ sphinx sphinx_rtd_theme -myst_parser --e . +myst_parser==0.16.1 attrs # required for myst, but not automatically installed by myst diff --git a/requirements/docs.txt b/requirements/docs.txt index ac8a6a95a..f681c6448 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,11 +1,9 @@ # -# This file is autogenerated by pip-compile with python 3.6 -# To update, run: +# This file is autogenerated by pip-compile with Python 3.7 +# by the following command: # -# pip-compile --output-file=requirements/docs.txt requirements/docs.in +# pip-compile requirements/docs.in # --e . - # via -r requirements/docs.in alabaster==0.7.13 # via sphinx attrs==22.2.0 @@ -16,9 +14,7 @@ certifi==2022.12.7 # via requests charset-normalizer==3.1.0 # via requests -colorama==0.4.6 - # via sphinx -docutils==0.18.1 +docutils==0.17.1 # via # myst-parser # sphinx @@ -43,19 +39,21 @@ mdit-py-plugins==0.3.5 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==1.0.0 +myst-parser==0.16.1 # via -r requirements/docs.in packaging==23.0 # via sphinx pygments==2.14.0 # via sphinx +pytz==2023.2 + # via babel pyyaml==6.0 # via myst-parser requests==2.28.2 # via sphinx snowballstemmer==2.2.0 # via sphinx -sphinx==6.1.3 +sphinx==4.5.0 # via # -r requirements/docs.in # myst-parser @@ -63,11 +61,11 @@ sphinx==6.1.3 # sphinxcontrib-jquery sphinx-rtd-theme==1.2.0 # via -r requirements/docs.in -sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-applehelp==1.0.2 # via sphinx sphinxcontrib-devhelp==1.0.2 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.0 # via sphinx sphinxcontrib-jquery==4.1 # via sphinx-rtd-theme @@ -78,7 +76,9 @@ sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 # via sphinx typing-extensions==4.5.0 - # via pypdf + # via + # importlib-metadata + # markdown-it-py urllib3==1.26.15 # via requests zipp==3.15.0