Skip to content

Commit

Permalink
Add RTD logic
Browse files Browse the repository at this point in the history
  • Loading branch information
tridelat committed Feb 10, 2020
1 parent 09f2a7e commit 8b6a3a1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,16 @@
# serve to show the default.

import sys
import os
import subprocess, os
# import sphinx_bootstrap_theme

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
# build C++ docs
subprocess.call('cd ..; doxygen', shell=True)
# build proteus
subprocess.call('cd ../..; make develop-conda', shell=True)

try:
import proteus
except ImportError:
Expand Down
20 changes: 20 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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: docs/source/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

conda:
environment: environment-dev.yml

0 comments on commit 8b6a3a1

Please sign in to comment.