Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing read the docs build #138

Merged
merged 10 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 5 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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),
}
2 changes: 2 additions & 0 deletions docs/modules/maps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,7 @@ maps API
========

.. py:module:: pygbif
:noindex:

.. automethod:: maps.map

1 change: 1 addition & 0 deletions docs/modules/registry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ registry API
============

.. py:module:: pygbif
:noindex:

.. automethod:: registry.datasets
.. automethod:: registry.dataset_metrics
Expand Down
1 change: 1 addition & 0 deletions docs/modules/species.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ species API
===========

.. py:module:: pygbif
:noindex:

.. automethod:: species.name_backbone
.. automethod:: species.name_suggest
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ vcrpy==4.2.1
pytest
pytest-cov
codecov
sphinx_rtd_theme
Loading