Skip to content

Commit

Permalink
initial setup of rtd build
Browse files Browse the repository at this point in the history
  • Loading branch information
leewujung committed Feb 23, 2024
1 parent f653ba7 commit 4f83382
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
39 changes: 39 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 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: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"
jobs:
pre_build:
# Generate the Sphinx configuration for this Jupyter Book so it builds.
- "jupyter-book config sphinx docs"

# Build documentation in the "docs/" directory with Sphinx
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

# 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
File renamed without changes.
4 changes: 3 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ latex:
# Information about where the book exists on the web
repository:
url: https://github.com/uw-echospace/EchoPro # Online location of your book
# path_to_book: docs # Optional path to your book, relative to the repository root
path_to_book: docs # Optional path to your book, relative to the repository root
branch: master # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
Expand All @@ -48,3 +48,5 @@ sphinx:
'sphinx.ext.ifconfig',
'sphinx.ext.githubpages'
]
config:
bibtex_reference_style: label
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx-automodapi
jupyter-book
numpydoc
docutils<0.18

0 comments on commit 4f83382

Please sign in to comment.