Skip to content

Commit

Permalink
DOC: Add readthedocs configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
thclark committed Oct 24, 2023
1 parent 0ad5c6e commit 717485d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 9 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: '3.12'
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

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

# 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
10 changes: 1 addition & 9 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,13 @@

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# Breate and exhale are added as recommended by:
# https://exhale.readthedocs.io/en/latest/usage.html#usage-quickstart-guide
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinx_tabs.tabs",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
]

Expand All @@ -59,7 +51,7 @@
master_doc = "index"

# General information about the project.
project = "django_gcp"
project = "django_svelte_jsoneditor"
copyright = "2023 Octue Ltd"

# The version info for the project you're documenting, acts as replacement for
Expand Down

0 comments on commit 717485d

Please sign in to comment.