doc: Add readthedocs config

jonasblixt · Apr 15, 2023 · dd1539a · dd1539a
1 parent 7a617b5
commit dd1539a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.8
+   install:
+   - requirements: doc/requirements.txt
diff --git a/doc/source/conf.py → doc/conf.py b/doc/source/conf.py → doc/conf.py
@@ -35,9 +35,6 @@
 
 # -- General configuration ---------------------------------------------------
 
-read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
-
-#if read_the_docs_build:
 subprocess.call('doxygen ../doxygen.cfg', shell=True)
 
 # If extensions (or modules to document with autodoc) are in another directory,

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,4 @@
+breathe
+sphinx_rtd_theme
+semver
+sphinxcontrib-plantuml