From bb99eee4e57910307a2941b8281399ac53873afc Mon Sep 17 00:00:00 2001 From: John Waller Date: Thu, 7 Mar 2024 13:05:09 +0100 Subject: [PATCH] Fixing read the docs build (#138) --- .readthedocs.yaml | 6 +++--- docs/conf.py | 8 +++++--- docs/modules/maps.rst | 2 ++ docs/modules/registry.rst | 1 + docs/modules/species.rst | 1 + requirements.txt | 1 + 6 files changed, 13 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c3570ca..cf38008 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -22,6 +22,6 @@ formats: # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 63bfa1a..372eabf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,7 +73,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -146,7 +146,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +# html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -293,4 +293,6 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {"https://docs.python.org/": None} +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), +} diff --git a/docs/modules/maps.rst b/docs/modules/maps.rst index e2b1349..f563e8e 100644 --- a/docs/modules/maps.rst +++ b/docs/modules/maps.rst @@ -20,5 +20,7 @@ maps API ======== .. py:module:: pygbif + :noindex: .. automethod:: maps.map + diff --git a/docs/modules/registry.rst b/docs/modules/registry.rst index 1712ec5..8ab26e7 100644 --- a/docs/modules/registry.rst +++ b/docs/modules/registry.rst @@ -27,6 +27,7 @@ registry API ============ .. py:module:: pygbif + :noindex: .. automethod:: registry.datasets .. automethod:: registry.dataset_metrics diff --git a/docs/modules/species.rst b/docs/modules/species.rst index 755d813..0e53daa 100644 --- a/docs/modules/species.rst +++ b/docs/modules/species.rst @@ -24,6 +24,7 @@ species API =========== .. py:module:: pygbif + :noindex: .. automethod:: species.name_backbone .. automethod:: species.name_suggest diff --git a/requirements.txt b/requirements.txt index 773c061..797e554 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,3 +13,4 @@ vcrpy==4.2.1 pytest pytest-cov codecov +sphinx_rtd_theme