Skip to content

Commit

Permalink
update .readthedocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Soren B. Scott committed Dec 1, 2023
1 parent 3d73774 commit 45445c9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 19 deletions.
30 changes: 15 additions & 15 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

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

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

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

# Optionally set the version of Python and requirements required to build your docs
# Explicitly set the version of Python and its requirements
python:
version: 3.6
install:
- requirements: docs/requirements.txt
- requirements: docs/requirements.txt

# Build documentation in the "docs/source/" directory with Sphinx
# We would like move docs/source/conf.py to docs/conf.py, in order to
# separate the structural stuff and the documentation source files,
# but it seems that as of now it is a requirement that conf.py be in
# the same folder as the main index.rst.
sphinx:
configuration: docs/source/conf.py
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# needed as per https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html

sphinx
sphinx_rtd_theme
sphinx-rtd-theme
readthedocs-sphinx-search
nbsphinx
ixdat
docutils<0.18 # see https://github.com/sphinx-doc/sphinx/issues/9727
4 changes: 1 addition & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,9 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
import sphinx_rtd_theme

# import sphinx_automodapi # see https://github.com/astropy/

extensions = [
"sphinx_rtd_theme",
"sphinx.ext.autodoc",
# "sphinx_automodapi.automodapi", # see https://github.com/astropy/
"sphinx.ext.coverage",
Expand Down

0 comments on commit 45445c9

Please sign in to comment.