Skip to content

Commit

Permalink
Merge pull request #47 from pnkraemer/sphinx
Browse files Browse the repository at this point in the history
Sphinx
  • Loading branch information
pnkraemer authored Feb 7, 2022
2 parents 3199979 + 449c177 commit 6d1c770
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# .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.8"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/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-sphinx-build.txt
# We need to install tueplots in order to make autodoc find the modules
- method: pip
path: .
1 change: 0 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ description = Build the HTML docs
passenv = HOME
deps =
-r {toxinidir}/docs/requirements-sphinx-build.txt
sphinx-autodoc-typehints # hack. No idea why necessary
changedir = docs
whitelist_externals = make
commands =
Expand Down

0 comments on commit 6d1c770

Please sign in to comment.