Skip to content

Commit

Permalink
Modification to documentation setup
Browse files Browse the repository at this point in the history
  • Loading branch information
stammler committed Dec 8, 2023
1 parent 1473006 commit acd5cde
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 23 deletions.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .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.12"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
20 changes: 0 additions & 20 deletions .readthedocs.yml

This file was deleted.

3 changes: 2 additions & 1 deletion docs_source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ recommonmark
simframe
sphinx
sphinx-automodapi
sphinx_rtd_theme
sphinx_rtd_theme
.
4 changes: 2 additions & 2 deletions docs_source/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
from pathlib import Path
import sys
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, Path(__file__).parents[1].absolute())


# -- Project information -----------------------------------------------------
Expand Down

0 comments on commit acd5cde

Please sign in to comment.