Skip to content

Commit

Permalink
Fix documentation builds from further breaking RTD API changes
Browse files Browse the repository at this point in the history
Use the opportunity to add standard documentation and order of
definitions in the updated YAML file as well as standard "docs"
folder name.
  • Loading branch information
pevogam committed Apr 29, 2024
1 parent 4d3608e commit 1895554
Show file tree
Hide file tree
Showing 38 changed files with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
version: 2
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

python:
version: 3.7
install:
- requirements: requirements_pip.txt
# TODO: pip-crippled vt dependency and no RTD scripts supported
#- method: pip
# path: .
# Required
version: 2

formats: all
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

# Build documentation in the docs/api directory with Sphinx
sphinx:
builder: html
configuration: doc/api/conf.py
configuration: docs/api/conf.py
# TODO: investigate warnings
fail_on_warning: false

# Build docs in additional formats such as PDF and ePub
formats: all

# Specify dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
#python:
# install:
# TODO: pip-crippled vt dependency (104) and no RTD scripts supported
# - requirements: requirements_pip.txt
# - method: pip
# path: .
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 1895554

Please sign in to comment.