Skip to content

Commit

Permalink
Add rtd config
Browse files Browse the repository at this point in the history
  • Loading branch information
dlobato committed Jun 25, 2024

Verified

This commit was signed with the committer’s verified signature.
erijo Erik Flodin
1 parent 850d36e commit 92415c1
Showing 2 changed files with 32 additions and 3 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .readthedocs.yaml
# Read the Docs configuration file
# 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-22.04
tools:
python: "3.12"
jobs:
pre_build:
- cd docs && make actionlinks

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

# 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:
- requirements: docs/requirements.txt
4 changes: 1 addition & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -34,7 +34,6 @@
sys.path.insert(0, os.path.join("client"))
sys.path.insert(0, os.path.abspath(".."))


# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -82,7 +81,7 @@

release = open("../VERSION").read().split()[0].strip()
# Assume PEP 440 version strings
p = re.compile("(\d+!)?((\d+)(.\d+)*(.\d+)*)(.?[a|b|rc]\d*)?(.post\d*)?(.dev\d*)?", re.IGNORECASE)
p = re.compile(r"(\d+!)?((\d+)(.\d+)*(.\d+)*)(.?(a|b|rc)\d*)?(.post\d*)?(.dev\d*)?", re.IGNORECASE)
vers = p.search(release)
version = vers.group(2)

@@ -207,7 +206,6 @@
# Output file base name for HTML help builder.
htmlhelp_basename = "ZTPServerdoc"


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {

0 comments on commit 92415c1

Please sign in to comment.