Skip to content

Commit

Permalink
Updating manifest and RTD config.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamadden committed Dec 6, 2024
1 parent 8b99791 commit 0635fa7
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 14 deletions.
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,5 @@ include/
lib/
parts/

doc/_build/
doc/__pycache__
doc/relstorage.*.rst
docs/_build/
docs/__pycache__
34 changes: 26 additions & 8 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
# .readthedocs.yaml
# .readthedocs.yml
# 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:
configuration: doc/conf.py
builder: html
configuration: docs/conf.py

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Optionally set the version of Python and requirements required to build your docs
# Set the version of Python and requirements required to build your
# docs
python:
version: "3.7"
install:
- method: pip
path: .
- requirements: doc/requirements.txt
install:
- method: pip
path: .
extra_requirements:
- docs
5 changes: 4 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,8 @@ include tox.ini
include .travis.yml
include .coveragerc
include .pylintrc
include *.txt
include *.yml

recursive-include src *.py
recursive-include doc *.rst *.py
recursive-include doc *.rst *.py *.txt
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ def read_version_number():
],
extras_require={
'test': tests_require,
'docs': [
],
},
python_requires=">=3.8",
)
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ passenv = HOME

[testenv:doc]
commands =
sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees doc {envtmpdir}/linkcheck
sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs {envtmpdir}/linkcheck
sphinx-build -W -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html

0 comments on commit 0635fa7

Please sign in to comment.