Skip to content

Commit

Permalink
Update Sphinx config (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
ianlini authored Nov 7, 2024
1 parent c8dd761 commit ad553de
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 13 deletions.
33 changes: 23 additions & 10 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,38 @@
# .readthedocs.yml
# Read the Docs configuration file
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

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

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# formats:
# - pdf
# - epub

# Optionally set the version of Python and requirements required to build your docs
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
version: 3.8
install:
- method: pip # build using pip for poetry
path: .
- requirements: docs/requirements.txt
# Optionally set the version of Python and requirements required to build your docs
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Contributing

* Linter: ``flake8``.
* Test using the current environment: ``pytest``.
* For Python 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, flake8 and installation test: ``tox``.
* For Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, 3.14 flake8 and installation test: ``tox``.
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx==3.2.1
sphinx-rtd-theme==0.5.0
sphinx==8.1.3
sphinx-rtd-theme==3.0.1

0 comments on commit ad553de

Please sign in to comment.