diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9c3157c50b..61aac930a8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,19 +13,31 @@ build: # DO NOT use mambaforge-*; that is currently sunsetted python: "miniconda-latest" jobs: - post_create_environment: - - conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps + post_checkout: + # The ESMValCore repository is shallow i.e., has a .git/shallow, + # therefore complete the repository with a full history in order + # to allow setuptools-scm to correctly auto-discover the version. + - git fetch --unshallow + - git fetch --all + pre_install: + - git stash + post_install: + - git stash pop # Declare the requirements required to build your docs conda: - environment: - environment.yml + environment: environment.yml # Build documentation in the doc directory with Sphinx sphinx: configuration: doc/conf.py fail_on_warning: true +python: + install: + - method: pip + path: . + # If using Sphinx, optionally build your docs in additional formats such as PDF formats: - pdf diff --git a/doc/conf.py b/doc/conf.py index 1f2dd91595..9cd31c1491 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -99,7 +99,7 @@ master_doc = 'index' # General information about the project. -project = u'ESMValTool' +project = u'ESMValCore' copyright = u'{0}, ESMValTool Development Team'.format(datetime.now().year) # The version info for the project you're documenting, acts as replacement for