From 9beae36ca4cc8cb0026b07bcfb2ae7fd2a24147b Mon Sep 17 00:00:00 2001 From: jmcvey3 <53623232+jmcvey3@users.noreply.github.com> Date: Fri, 8 Dec 2023 11:00:05 -0800 Subject: [PATCH] Fix readthedocs build --- .readthedocs.yml | 40 ++++++++++++++++++++++++++++++++++------ docs/conf.py | 10 ++++++---- docs/environment.yml | 2 +- 3 files changed, 41 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 5746ff48..557e955e 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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 \ No newline at end of file +# 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 diff --git a/docs/conf.py b/docs/conf.py index bfa553fa..481ba807 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'] @@ -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 @@ -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. diff --git a/docs/environment.yml b/docs/environment.yml index 57988f32..46781c21 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -3,7 +3,7 @@ channels: - defaults dependencies: - pip - - python>=3.6 + - python>=3.8 - pip: - alabaster>=0.7.12 - atomicwrites>=1.4.0