Skip to content

Commit

Permalink
Added conf.py
Browse files Browse the repository at this point in the history
  • Loading branch information
rsoric committed Oct 17, 2023
1 parent df71e3e commit 7bff0e6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
30 changes: 27 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
# Read the Docs configuration file for MkDocs projects
# Read the Docs configuration file for Sphinx projects
# 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
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
python: "3.11"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: build/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
5 changes: 5 additions & 0 deletions build/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
extensions = [
'sphinx_rtd_theme',
'sphinx.ext.autodoc',
'sphinx_autodoc_typehints'
]

0 comments on commit 7bff0e6

Please sign in to comment.