Skip to content

Commit

Permalink
Update .readthedocs.yaml w/newly required fields (#805)
Browse files Browse the repository at this point in the history
* update .readthedocs.yaml w/new required fields

* add html_context to conf.py

* add sphinx_rtd_theme to extensions

* add requirements.txt doc
  • Loading branch information
gspetro-NOAA authored Oct 19, 2023
1 parent 9a191de commit fa09239
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
11 changes: 7 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

# Required
version: 2
build:
os: ubuntu-20.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -17,8 +21,7 @@ sphinx:
formats: all

# Optionally set the version of Python and requirements required to build your docs
#python:
python:
# version: 3.7
# install:

# - requirements: docs/requirements.txt
install:
- requirements: docs/requirements.txt
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx_rtd_theme',
'sphinx.ext.autosectionlabel'
]
autosectionlabel_prefix_document = True
Expand Down Expand Up @@ -69,6 +70,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_context = {}

# Add custom style sheets
def setup(app):
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinxcontrib-bibtex
sphinx_rtd_theme
docutils==0.16

0 comments on commit fa09239

Please sign in to comment.