diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 19401c31c..140ad92b8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -24,3 +24,5 @@ python: - requirements: doc/requirements.txt - method: pip path: . + extra_requirements: + - docs diff --git a/doc/requirements.in b/doc/requirements.in new file mode 100644 index 000000000..c0bfd65e4 --- /dev/null +++ b/doc/requirements.in @@ -0,0 +1,8 @@ +# Input file for pip-compile +# Only specify the packages necessary for [docs] + +gitpython==3.1.32 +numpydoc==1.5.0 +sphinx==6.2.1 +sphinx-rtd-theme==1.2.2 +sphinxcontrib-bibtex==2.5.0 \ No newline at end of file diff --git a/doc/requirements.txt b/doc/requirements.txt index 66495a7aa..e3eabeecc 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,599 +2,91 @@ # This file is autogenerated by pip-compile with Python 3.10 # by the following command: # -# pip-compile --allow-unsafe --extra=docs --output-file=doc/requirements.txt pyproject.toml +# pip-compile --allow-unsafe --config=pyproject.toml --output-file=doc/requirements.txt doc/requirements.in # alabaster==0.7.13 # via sphinx -anyio==3.7.1 - # via - # httpcore - # jupyter-server -argon2-cffi==21.3.0 - # via jupyter-server -argon2-cffi-bindings==21.2.0 - # via argon2-cffi -argparse==1.4.0 - # via pretenders -arrow==1.2.3 - # via isoduration -asttokens==2.2.1 - # via stack-data -async-lru==2.0.4 - # via jupyterlab -attrs==23.1.0 - # via - # jsonschema - # referencing babel==2.12.1 - # via - # jupyterlab-server - # sphinx -backcall==0.2.0 - # via ipython -beautifulsoup4==4.12.2 - # via nbconvert -bleach==6.0.0 - # via nbconvert -bottle==0.12.25 - # via pretenders + # via sphinx certifi==2023.7.22 - # via - # httpcore - # httpx - # requests -cffi==1.15.1 - # via argon2-cffi-bindings + # via requests charset-normalizer==3.2.0 # via requests -click==8.1.6 - # via - # dask - # ixmp - # ixmp (pyproject.toml) -cloudpickle==2.2.1 - # via dask -comm==0.1.4 - # via - # ipykernel - # ipywidgets -contourpy==1.1.0 - # via matplotlib -coverage[toml]==7.2.7 - # via pytest-cov -cycler==0.11.0 - # via matplotlib -dask[array]==2023.8.0 - # via genno -debugpy==1.6.7 - # via ipykernel -decorator==5.1.1 - # via ipython -defusedxml==0.7.1 - # via nbconvert docutils==0.18.1 # via # pybtex-docutils # sphinx # sphinx-rtd-theme # sphinxcontrib-bibtex -et-xmlfile==1.1.0 - # via openpyxl -exceptiongroup==1.1.2 - # via - # anyio - # pytest -executing==1.2.0 - # via stack-data -fastjsonschema==2.18.0 - # via nbformat -fonttools==4.42.0 - # via matplotlib -fqdn==1.5.1 - # via jsonschema -fsspec==2023.6.0 - # via dask -genno[compat,graphviz,plotnine,pyam]==1.17.2 ; python_version >= "3.8" - # via - # ixmp - # ixmp (pyproject.toml) gitdb==4.0.10 # via gitpython gitpython==3.1.32 - # via ixmp (pyproject.toml) -graphviz==0.20.1 - # via genno -h11==0.14.0 - # via httpcore -h2==4.1.0 - # via httpx -hpack==4.0.0 - # via h2 -httpcore==0.17.3 - # via httpx -httpx[http2]==0.24.1 - # via pyam-iamc -hyperframe==6.0.1 - # via h2 -iam-units==2022.10.27 - # via pyam-iamc + # via -r doc/requirements.in idna==3.4 - # via - # anyio - # httpx - # jsonschema - # requests + # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==6.8.0 - # via - # dask - # pyam-iamc -iniconfig==2.0.0 - # via pytest -ipykernel==6.25.0 - # via - # jupyter - # jupyter-console - # jupyterlab - # qtconsole -ipython==8.14.0 - # via - # ipykernel - # ipywidgets - # jupyter-console -ipython-genutils==0.2.0 - # via qtconsole -ipywidgets==8.1.0 - # via jupyter -isoduration==20.11.0 - # via jsonschema -jedi==0.19.0 - # via ipython jinja2==3.1.2 # via - # jupyter-server - # jupyterlab - # jupyterlab-server - # nbconvert # numpydoc # sphinx -jpype1==1.4.1 - # via - # ixmp - # ixmp (pyproject.toml) -json5==0.9.14 - # via jupyterlab-server -jsonpointer==2.4 - # via jsonschema -jsonschema[format-nongpl]==4.19.0 - # via - # jupyter-events - # jupyterlab-server - # nbformat -jsonschema-specifications==2023.7.1 - # via jsonschema -jupyter==1.0.0 - # via ixmp -jupyter-client==8.3.0 - # via - # ipykernel - # jupyter-console - # jupyter-server - # nbclient - # qtconsole -jupyter-console==6.6.3 - # via jupyter -jupyter-core==5.3.1 - # via - # ipykernel - # jupyter-client - # jupyter-console - # jupyter-server - # jupyterlab - # nbclient - # nbconvert - # nbformat - # qtconsole -jupyter-events==0.7.0 - # via jupyter-server -jupyter-lsp==2.2.0 - # via jupyterlab -jupyter-server==2.7.0 - # via - # jupyter-lsp - # jupyterlab - # jupyterlab-server - # notebook - # notebook-shim -jupyter-server-terminals==0.4.4 - # via jupyter-server -jupyterlab==4.0.4 - # via notebook -jupyterlab-pygments==0.2.2 - # via nbconvert -jupyterlab-server==2.24.0 - # via - # jupyterlab - # notebook -jupyterlab-widgets==3.0.8 - # via ipywidgets -kiwisolver==1.4.4 - # via matplotlib latexcodec==2.0.1 # via pybtex -locket==1.0.0 - # via partd markupsafe==2.1.3 - # via - # jinja2 - # nbconvert -matplotlib==3.7.0 - # via - # mizani - # plotnine - # pyam-iamc - # seaborn -matplotlib-inline==0.1.6 - # via - # ipykernel - # ipython -memory-profiler==0.61.0 - # via ixmp -mistune==3.0.1 - # via nbconvert -mizani==0.9.2 - # via plotnine -nbclient==0.8.0 - # via - # ixmp - # nbconvert -nbconvert==7.7.3 - # via - # jupyter - # jupyter-server -nbformat==5.9.2 - # via - # jupyter-server - # nbclient - # nbconvert -nest-asyncio==1.5.7 - # via ipykernel -notebook==7.0.2 - # via jupyter -notebook-shim==0.2.3 - # via - # jupyterlab - # notebook -numpy==1.23.5 - # via - # contourpy - # dask - # matplotlib - # mizani - # pandas - # patsy - # plotnine - # pyam-iamc - # scipy - # seaborn - # statsmodels - # wquantiles - # xarray + # via jinja2 numpydoc==1.5.0 - # via ixmp (pyproject.toml) -openpyxl==3.1.2 - # via - # ixmp - # ixmp (pyproject.toml) - # pyam-iamc -overrides==7.4.0 - # via jupyter-server + # via -r doc/requirements.in packaging==23.1 - # via - # dask - # ipykernel - # jpype1 - # jupyter-server - # jupyterlab - # jupyterlab-server - # matplotlib - # nbconvert - # pytest - # pytest-rerunfailures - # qtconsole - # qtpy - # setuptools-scm - # sphinx - # statsmodels - # xarray -pandas==2.0.3 - # via - # genno - # ixmp - # ixmp (pyproject.toml) - # mizani - # plotnine - # pyam-iamc - # seaborn - # statsmodels - # xarray -pandocfilters==1.5.0 - # via nbconvert -parso==0.8.3 - # via jedi -partd==1.4.0 - # via dask -patsy==0.5.3 - # via - # plotnine - # statsmodels -pexpect==4.8.0 - # via ipython -pickleshare==0.7.5 - # via ipython -pillow==10.0.0 - # via matplotlib -pint==0.22 - # via - # genno - # iam-units - # ixmp - # ixmp (pyproject.toml) - # pyam-iamc -platformdirs==3.10.0 - # via jupyter-core -plotnine==0.12.2 - # via genno -pluggy==1.2.0 - # via pytest -pretenders==1.4.5 - # via ixmp -prometheus-client==0.17.1 - # via jupyter-server -prompt-toolkit==3.0.39 - # via - # ipython - # jupyter-console -psutil==5.9.5 - # via - # ipykernel - # memory-profiler -ptyprocess==0.7.0 - # via - # pexpect - # terminado -pure-eval==0.2.2 - # via stack-data -py-cpuinfo==9.0.0 - # via pytest-benchmark -pyam-iamc==1.9.0 - # via genno + # via sphinx pybtex==0.24.0 # via # pybtex-docutils # sphinxcontrib-bibtex pybtex-docutils==1.0.2 # via sphinxcontrib-bibtex -pycparser==2.21 - # via cffi pygments==2.16.1 - # via - # ipython - # jupyter-console - # nbconvert - # qtconsole - # sphinx -pyjwt==2.8.0 - # via pyam-iamc -pyparsing==3.1.1 - # via matplotlib -pytest==7.4.0 - # via - # ixmp - # pytest-benchmark - # pytest-cov - # pytest-rerunfailures -pytest-benchmark==4.0.0 - # via ixmp -pytest-cov==4.1.0 - # via ixmp -pytest-rerunfailures==12.0 - # via ixmp -python-dateutil==2.8.2 - # via - # arrow - # jupyter-client - # matplotlib - # pandas -python-json-logger==2.0.7 - # via jupyter-events -pytz==2023.3 - # via pandas + # via sphinx pyyaml==6.0.1 - # via - # dask - # genno - # ixmp - # ixmp (pyproject.toml) - # jupyter-events - # pyam-iamc - # pybtex -pyzmq==25.1.0 - # via - # ipykernel - # jupyter-client - # jupyter-console - # jupyter-server - # qtconsole -qtconsole==5.4.3 - # via jupyter -qtpy==2.3.1 - # via qtconsole -referencing==0.30.2 - # via - # jsonschema - # jsonschema-specifications - # jupyter-events + # via pybtex requests==2.31.0 - # via - # jupyterlab-server - # pyam-iamc - # sphinx -rfc3339-validator==0.1.4 - # via - # jsonschema - # jupyter-events -rfc3986-validator==0.1.1 - # via - # jsonschema - # jupyter-events -rpds-py==0.9.2 - # via - # jsonschema - # referencing -scipy==1.11.1 - # via - # mizani - # plotnine - # pyam-iamc - # statsmodels -seaborn==0.12.2 - # via pyam-iamc -send2trash==1.8.2 - # via jupyter-server -setuptools-scm==7.1.0 - # via pyam-iamc + # via sphinx six==1.16.0 # via - # asttokens - # bleach # latexcodec - # patsy - # pyam-iamc # pybtex - # python-dateutil - # rfc3339-validator smmap==5.0.0 # via gitdb -sniffio==1.3.0 - # via - # anyio - # httpcore - # httpx snowballstemmer==2.2.0 # via sphinx -soupsieve==2.4.1 - # via beautifulsoup4 sphinx==6.2.1 # via - # ixmp (pyproject.toml) + # -r doc/requirements.in # numpydoc # sphinx-rtd-theme + # sphinxcontrib-applehelp # sphinxcontrib-bibtex + # sphinxcontrib-devhelp + # sphinxcontrib-htmlhelp # sphinxcontrib-jquery + # sphinxcontrib-qthelp + # sphinxcontrib-serializinghtml sphinx-rtd-theme==1.2.2 - # via ixmp (pyproject.toml) -sphinxcontrib-applehelp==1.0.4 + # via -r doc/requirements.in +sphinxcontrib-applehelp==1.0.5 # via sphinx sphinxcontrib-bibtex==2.5.0 - # via ixmp (pyproject.toml) -sphinxcontrib-devhelp==1.0.2 + # via -r doc/requirements.in +sphinxcontrib-devhelp==1.0.3 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.2 # via sphinx sphinxcontrib-jquery==4.1 # via sphinx-rtd-theme sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==1.0.4 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==1.1.6 # via sphinx -stack-data==0.6.2 - # via ipython -statsmodels==0.14.0 - # via plotnine -terminado==0.17.1 - # via - # jupyter-server - # jupyter-server-terminals -tinycss2==1.2.1 - # via nbconvert -tomli==2.0.1 - # via - # coverage - # jupyterlab - # pytest - # setuptools-scm -toolz==0.12.0 - # via - # dask - # partd -tornado==6.3.2 - # via - # ipykernel - # jupyter-client - # jupyter-server - # jupyterlab - # notebook - # terminado -traitlets==5.9.0 - # via - # comm - # ipykernel - # ipython - # ipywidgets - # jupyter-client - # jupyter-console - # jupyter-core - # jupyter-events - # jupyter-server - # jupyterlab - # matplotlib-inline - # nbclient - # nbconvert - # nbformat - # qtconsole -typing-extensions==4.7.1 - # via - # async-lru - # pint - # setuptools-scm -tzdata==2023.3 - # via pandas -uri-template==1.3.0 - # via jsonschema urllib3==2.0.4 # via requests -wcwidth==0.2.6 - # via prompt-toolkit -webcolors==1.13 - # via jsonschema -webencodings==0.5.1 - # via - # bleach - # tinycss2 -websocket-client==1.6.1 - # via jupyter-server -widgetsnbextension==4.0.8 - # via ipywidgets -wquantiles==0.6 - # via pyam-iamc -xarray==2023.7.0 - # via - # genno - # ixmp - # ixmp (pyproject.toml) -xlsxwriter==3.1.2 - # via pyam-iamc -zipp==3.16.2 - # via importlib-metadata - -# The following packages are considered to be unsafe in a requirements file: -setuptools==68.0.0 - # via - # genno - # iam-units - # pyam-iamc - # setuptools-scm