From f8a42508d116566f00abe094d4cfc1e713a70ebe Mon Sep 17 00:00:00 2001 From: Chad Smith Date: Tue, 14 Feb 2023 10:48:48 -0700 Subject: doc add --- .readthedocs.yaml | 30 ++++++++++++++++++++++++++++++ doc-requirements.txt | 1 + 2 files changed, 31 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 doc-requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..be40b4c2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,30 @@ +# .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-22.04 + tools: + python: "3.6" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/rtd/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: requirements.txt + - requirements: doc-requirements.txt diff --git a/doc-requirements.txt b/doc-requirements.txt new file mode 100644 index 00000000..6966869c --- /dev/null +++ b/doc-requirements.txt @@ -0,0 +1 @@ +sphinx -- cgit v1.2.1