Skip to content

Commit

Permalink
fix docs build.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamadden committed Nov 11, 2024
1 parent ab141de commit 1e13659
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 16 deletions.
22 changes: 20 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,33 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Some things can only be configured on the RTD dashboard.
# Those that we may have changed from the default include:

# Analytics code:
# Show Version Warning: False
# Single Version: True

# Required
version: 2

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

# Set the version of Python and requirements required to build your
# docs

build:
# os is required for some reason
os: ubuntu-22.04
tools:
python: "3.11"

# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
25 changes: 13 additions & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -165,20 +165,21 @@
]




# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'https://docs.python.org/': None,
'https://persistent.readthedocs.io/en/latest': None,
'https://pyramid.readthedocs.io/en/latest/': None,
'https://zopetraversing.readthedocs.io/en/latest/': None,
'https://zopesite.readthedocs.io/en/latest/': None,
'https://zopecomponent.readthedocs.io/en/latest/': None,
'https://zopeinterface.readthedocs.io/en/latest/': None,
'https://zopecontainer.readthedocs.io/en/latest/': None,
intersphinx_mapping = {
'component': ('https://zopecomponent.readthedocs.io/en/latest/', None),
'container': ('https://zopecontainer.readthedocs.io/en/latest/', None,),
'i18n': ('https://zopei18nmessageid.readthedocs.io/en/latest/', None),
'interface': ('https://zopeinterface.readthedocs.io/en/latest/', None),
'persistent': ('https://persistent.readthedocs.io/en/latest', None),
'python': ('https://docs.python.org/', None),
'schema': ('https://zopeschema.readthedocs.io/en/latest/', None),
'site': ('https://zopesite.readthedocs.io/en/latest/', None,),
'testing': ('https://ntitesting.readthedocs.io/en/latest/', None),
'traversing': ('https://zopetraversing.readthedocs.io/en/latest/', None),
'zodb': ('http://www.zodb.org/en/latest/', None),
}


extlinks = {
'issue': ('https://github.com/NextThought/nti.traversal/issues/%s',
'issue #'),
Expand Down
1 change: 0 additions & 1 deletion docs/requirements.txt

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def _read(fname):
'Sphinx >= 2.1',
'repoze.sphinx.autointerface',
'sphinx_rtd_theme',
]
] + TESTS_REQUIRE,
},
entry_points=entry_points,
python_requires=">=3.10",
Expand Down

0 comments on commit 1e13659

Please sign in to comment.