Skip to content

Commit

Permalink
Merge pull request #114 from iiasa/fix/docs
Browse files Browse the repository at this point in the history
Adapt to new RTD configuration style
  • Loading branch information
khaeru authored Aug 9, 2023
2 parents ec7e57a + 16d11a4 commit 419615a
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 16 deletions.
27 changes: 27 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Also build PDF format docs
formats:
- pdf

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py

python:
install:
- requirements: doc/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
16 changes: 0 additions & 16 deletions .readthedocs.yml

This file was deleted.

6 changes: 6 additions & 0 deletions doc/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Input file for pip-compile
# Only specify the packages necessary for [docs]

sphinx==6.2.1
sphinx-rtd-theme==1.2.2
sphinxcontrib-bibtex==2.5.0
76 changes: 76 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --allow-unsafe --output-file=requirements.txt requirements.in
#
alabaster==0.7.13
# via sphinx
babel==2.12.1
# via sphinx
certifi==2023.7.22
# via requests
charset-normalizer==3.2.0
# via requests
docutils==0.18.1
# via
# pybtex-docutils
# sphinx
# sphinx-rtd-theme
# sphinxcontrib-bibtex
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.2
# via sphinx
latexcodec==2.0.1
# via pybtex
markupsafe==2.1.3
# via jinja2
packaging==23.1
# via sphinx
pybtex==0.24.0
# via
# pybtex-docutils
# sphinxcontrib-bibtex
pybtex-docutils==1.0.2
# via sphinxcontrib-bibtex
pygments==2.16.1
# via sphinx
pyyaml==6.0.1
# via pybtex
requests==2.31.0
# via sphinx
six==1.16.0
# via
# latexcodec
# pybtex
snowballstemmer==2.2.0
# via sphinx
sphinx==6.2.1
# via
# -r requirements.in
# sphinx-rtd-theme
# sphinxcontrib-bibtex
# sphinxcontrib-jquery
sphinx-rtd-theme==1.2.2
# via -r requirements.in
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-bibtex==2.5.0
# via -r requirements.in
sphinxcontrib-devhelp==1.0.2
# via sphinx
sphinxcontrib-htmlhelp==2.0.1
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
urllib3==2.0.4
# via requests

0 comments on commit 419615a

Please sign in to comment.