Skip to content

Commit

Permalink
trying to fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewschaub committed Dec 30, 2024
1 parent 3fddad4 commit e0ff3bb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
5 changes: 3 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ version: 2

# Set the OS, Python version and other tools you might need
build:
image: "latest"
os: ubuntu-22.04
tools:
python: "3.12"
Expand All @@ -28,5 +29,5 @@ sphinx:
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
install:
- requirements: docs/requirements.txt
14 changes: 8 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,18 @@

import os
import sys
sys.path.insert(0, os.path.abspath('../..')) # Adjust as needed based on directory structure
sys.path.insert(0, os.path.abspath('../')) # Adjust as needed based on directory structure

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.napoleon',
'sphinx.ext.autodoc.typehints'
]
extensions = [
'sphinx.ext.autodoc', # Handles automatic documentation
'sphinx.ext.napoleon', # Supports Google-style and NumPy-style docstrings
'sphinx.ext.viewcode', # Adds links to source code
'sphinx.ext.autosummary', # Generates summary tables for modules/classes
'sphinx.ext.autodoc.typehints' # Adds support for type hints
]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
Expand Down

0 comments on commit e0ff3bb

Please sign in to comment.