Skip to content

Commit

Permalink
Fix readthedocs build
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcvey3 committed Dec 8, 2023
1 parent 1db3845 commit 9beae36
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 11 deletions.
40 changes: 34 additions & 6 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,37 @@
sphinx:
configuration: docs/conf.py
# 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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "mambaforge-22.9"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

conda:
file: docs/environment.yml
environment: docs/environment.yml

sphinx:
configuration: docs/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

python:
version: 3
setup_py_install: true
# 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: 6 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,10 @@
autodoc_member_order = 'bysource'
autoclass_content = 'both'
numfig = True
numfig_format = {'figure': 'Figure %s',
'table': 'Table %s', 'code-block': 'Listing %s'}
numfig_format = {'figure': 'Figure %s',
'table': 'Table %s',
'code-block': 'Listing %s'
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
Expand Down Expand Up @@ -124,7 +126,7 @@
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
Expand Down Expand Up @@ -163,7 +165,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# 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_static_path = ['.static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down
2 changes: 1 addition & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ channels:
- defaults
dependencies:
- pip
- python>=3.6
- python>=3.8
- pip:
- alabaster>=0.7.12
- atomicwrites>=1.4.0
Expand Down

0 comments on commit 9beae36

Please sign in to comment.