-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix documentation builds from further breaking RTD API changes
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
Showing
38 changed files
with
25 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.