Skip to content

Commit

Permalink
update readthedocs conf
Browse files Browse the repository at this point in the history
  • Loading branch information
larsbuntemeyer committed Jul 17, 2023
1 parent c46869e commit cb9368a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
28 changes: 14 additions & 14 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# .readthedocs.yml
# Required
version: 2

build:
os: ubuntu-20.04
jobs:
pre_install:
# see https://github.com/readthedocs/readthedocs.org/issues/8201
- git update-index --assume-unchanged ci/requirements/docs.yml docs/conf.py
# install py-cordex, needs to be editable
- pip install -e .
os: 'ubuntu-20.04'
tools:
python: mambaforge-4.10
python: 'mambaforge-4.10'

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

# Optionally set the version of Python and requirements required to build your docs
conda:
environment: ci/requirements/docs.yml
formats:
- epub
- pdf
environment: ci/requirements/docs.yml

python:
install:
- method: pip
path: .
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
# relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#
import sphinx_autosummary_accessors

from pyremo import __version__

autodoc_mock_imports = ["pint", "pydruint", "pyintorg", "cmor"]
Expand All @@ -41,13 +43,13 @@
"sphinx.ext.napoleon",
"sphinxcontrib.mockautodoc",
"numpydoc",
"sphinx_autosummary_accessors",
"nbsphinx",
"nbsphinx_link",
"IPython.sphinxext.ipython_directive",
"IPython.sphinxext.ipython_console_highlighting",
]

nbsphinx_allow_errors = True

extlinks = {
"issue": ("https://github.com/remo-rcm/pyremo/issues/%s", "GH"),
Expand All @@ -69,7 +71,8 @@
numpydoc_class_members_toctree = True
numpydoc_show_class_members = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# templates_path = ["_templates"]
templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
Expand Down

0 comments on commit cb9368a

Please sign in to comment.