Skip to content

Commit

Permalink
doc: Add readthedocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasblixt committed Apr 15, 2023
1 parent 7a617b5 commit d8f1033
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 5 deletions.
20 changes: 20 additions & 0 deletions .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/source/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
4 changes: 4 additions & 0 deletions doc/requirements.txt
@@ -0,0 +1,4 @@
breathe
sphinx_rtd_theme
semver
sphinxcontrib-plantuml
7 changes: 2 additions & 5 deletions doc/source/conf.py
Expand Up @@ -34,11 +34,8 @@


# -- General configuration ---------------------------------------------------

read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'

#if read_the_docs_build:
subprocess.call('doxygen ../doxygen.cfg', shell=True)
subprocess.call('set', shell=True)
subprocess.call('doxygen doxygen.cfg', shell=True)

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down
File renamed without changes.

0 comments on commit d8f1033

Please sign in to comment.