Skip to content

Commit

Permalink
Update docs build
Browse files Browse the repository at this point in the history
Signed-off-by: guillemdb <[email protected]>
  • Loading branch information
Guillemdb committed Sep 1, 2024
1 parent c46682a commit fe1b9d1
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 37 deletions.
35 changes: 29 additions & 6 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: "ubuntu-20.04"
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.10"
# 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/source/conf.py
# 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:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
- requirements: docs/requirements-rtd.txt
install:
- requirements: requirements.lock
8 changes: 0 additions & 8 deletions docs/requirements-docs.txt

This file was deleted.

23 changes: 0 additions & 23 deletions docs/requirements-rtd.txt

This file was deleted.

14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,20 @@ test = [
"tomli>=1.2.3",
"hypothesis>=6.24.6"
]
docs = ["sphinx",
"linkify-it-py",
"myst-parser",
"myst-nb",
"ruyaml",
"sphinx-autoapi",
"pydata-sphinx-theme",
"sphinx-autodoc2",
"sphinxcontrib-mermaid",
"sphinx_book_theme",
"jupyter-cache",
"sphinx-copybutton",
"sphinxext-opengraph",
"sphinxcontrib-bibtex"]

[build-system]
requires = ["hatchling"]
Expand Down

0 comments on commit fe1b9d1

Please sign in to comment.