Skip to content

Commit

Permalink
Merge pull request #131 from jalving/API-documentation
Browse files Browse the repository at this point in the history
Update readthedocs to v2
  • Loading branch information
rmisener committed Nov 27, 2023
2 parents b9600e2 + 8728025 commit f50290b
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 16 deletions.
65 changes: 60 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,64 @@
# Read the Docs configuration file
# Read the Docs configuration file for Sphinx projects

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

conda:
file: docs/environment.yml

# Required

version: 2


# Set the OS, Python version and other tools you might need

build:

os: ubuntu-22.04

tools:

python: "3.8"

# You can also specify other tool versions:

# nodejs: "20"

# rust: "1.70"

# golang: "1.20"


# 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:
version: 3.8
setup_py_install: true

install:

- requirements: docs/requirements.txt
11 changes: 0 additions & 11 deletions docs/environment.yml

This file was deleted.

10 changes: 10 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Required dependencies for Sphinx documentation
sphinx
sphinx-rtd-theme
numpy
pyomo
networkx
onnx
tensorflow
linear-tree
importlib-metadata

0 comments on commit f50290b

Please sign in to comment.