Skip to content

Commit

Permalink
add readthedocs config files
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Gordon committed Nov 26, 2021
1 parent bfa5dcc commit f4483a6
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .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 version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ def __getattr__(cls,name):
sys.path.insert(0, os.path.abspath('../tools/twutils/src/twutils/command_line'))
sys.path.insert(0, os.path.abspath('../tools/twutils/src/twutils/QO'))
sys.path.insert(0, os.path.abspath('../tools/twutils/src/twutils'))
sys.path.append(os.path.abspath('./ext/breathe/'))

read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
breathe

0 comments on commit f4483a6

Please sign in to comment.