diff --git a/.readthedocs.yml b/.readthedocs.yml index 29c410e7..6e41af22 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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 \ No newline at end of file diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index 4044f80e..00000000 --- a/docs/environment.yml +++ /dev/null @@ -1,11 +0,0 @@ -name: omlt -channels: - - conda-forge -dependencies: - - python=3.8 - - numpy - - pyomo - - networkx - - onnx - - tensorflow - - importlib-metadata \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..6305e50b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,10 @@ +# Required dependencies for Sphinx documentation +sphinx +sphinx-rtd-theme +numpy +pyomo +networkx +onnx +tensorflow +linear-tree +importlib-metadata \ No newline at end of file