diff --git a/conda-recipe.yaml b/conda-recipe.yaml index 3ef835e8..9fca4bb1 100644 --- a/conda-recipe.yaml +++ b/conda-recipe.yaml @@ -22,6 +22,8 @@ dependencies: - pytorch::pytorch-mutex = *=*cuda* - pip: - functorch + - torchviz + - sphinxcontrib-katex # for documentation - jax - jaxlib >= 0.3=*cuda* - optax @@ -51,10 +53,16 @@ dependencies: # Documentation - sphinx - - sphinxcontrib-spelling + - sphinx_rtd_theme - sphinx-autobuild - sphinx-copybutton - - sphinx_rtd_theme + - sphinxcontrib-spelling + - sphinxcontrib-bibtex + - sphinx-autodoc-typehints + - myst-nb + - ipykernel + - pandoc + - docutils # Testing - pytest diff --git a/docs/Makefile b/docs/Makefile index d4bb2cbb..d0c3cbf1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,8 +5,8 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build +SOURCEDIR = source +BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/requirements.txt b/docs/requirements.txt index 1bb05dbf..61b877af 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -5,8 +5,11 @@ functorch --requirement ../requirements.txt -sphinx -sphinx_rtd_theme +sphinx >= 5.0 +sphinx-autoapi +sphinx-autobuild +sphinx-copybutton +sphinx-rtd-theme sphinxcontrib-katex sphinxcontrib-bibtex sphinx-autodoc-typehints diff --git a/docs/_static/css/style.css b/docs/source/_static/css/style.css similarity index 100% rename from docs/_static/css/style.css rename to docs/source/_static/css/style.css diff --git a/docs/_static/images/logo-torchopt.pdf b/docs/source/_static/images/logo-torchopt.pdf similarity index 100% rename from docs/_static/images/logo-torchopt.pdf rename to docs/source/_static/images/logo-torchopt.pdf diff --git a/docs/_static/images/logod-05.png b/docs/source/_static/images/logod-05.png similarity index 100% rename from docs/_static/images/logod-05.png rename to docs/source/_static/images/logod-05.png diff --git a/docs/_static/images/logod-07.png b/docs/source/_static/images/logod-07.png similarity index 100% rename from docs/_static/images/logod-07.png rename to docs/source/_static/images/logod-07.png diff --git a/docs/_static/images/maml-accs.png b/docs/source/_static/images/maml-accs.png similarity index 100% rename from docs/_static/images/maml-accs.png rename to docs/source/_static/images/maml-accs.png diff --git a/docs/_static/js/copybutton.js b/docs/source/_static/js/copybutton.js similarity index 100% rename from docs/_static/js/copybutton.js rename to docs/source/_static/js/copybutton.js diff --git a/docs/api/api.rst b/docs/source/api/api.rst similarity index 100% rename from docs/api/api.rst rename to docs/source/api/api.rst diff --git a/docs/bibtex.json b/docs/source/bibtex.json similarity index 100% rename from docs/bibtex.json rename to docs/source/bibtex.json diff --git a/docs/conf.py b/docs/source/conf.py similarity index 99% rename from docs/conf.py rename to docs/source/conf.py index a1726bc3..03e1b346 100644 --- a/docs/conf.py +++ b/docs/source/conf.py @@ -38,7 +38,7 @@ HERE = pathlib.Path(__file__).absolute().parent -PROJECT_ROOT = HERE.parent +PROJECT_ROOT = HERE.parent.parent def get_version() -> str: diff --git a/docs/developer/contributing.rst b/docs/source/developer/contributing.rst similarity index 97% rename from docs/developer/contributing.rst rename to docs/source/developer/contributing.rst index 10f1a25c..a99a7118 100644 --- a/docs/developer/contributing.rst +++ b/docs/source/developer/contributing.rst @@ -23,7 +23,7 @@ Lint Check We use several tools to secure code quality, including -- PEP8 code style: flake8, yapf, isort; +- PEP8 code style: flake8, isort, black; - Type check: mypy; - C++ Google-style: cpplint, clang-format; - License: addlicense; diff --git a/docs/developer/contributor.rst b/docs/source/developer/contributor.rst similarity index 100% rename from docs/developer/contributor.rst rename to docs/source/developer/contributor.rst diff --git a/docs/examples/MAML.rst b/docs/source/examples/MAML.rst similarity index 100% rename from docs/examples/MAML.rst rename to docs/source/examples/MAML.rst diff --git a/docs/index.rst b/docs/source/index.rst similarity index 100% rename from docs/index.rst rename to docs/source/index.rst diff --git a/docs/refs.bib b/docs/source/refs.bib similarity index 100% rename from docs/refs.bib rename to docs/source/refs.bib diff --git a/docs/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt similarity index 100% rename from docs/spelling_wordlist.txt rename to docs/source/spelling_wordlist.txt diff --git a/docs/torchopt101/torchopt-101.rst b/docs/source/torchopt101/torchopt-101.rst similarity index 100% rename from docs/torchopt101/torchopt-101.rst rename to docs/source/torchopt101/torchopt-101.rst diff --git a/tests/requirements.txt b/tests/requirements.txt index 2bbfedbe..30f20cb8 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -9,7 +9,7 @@ pytest pytest-cov pytest-xdist isort -yapf +black >= 22.6.0 mypy flake8 flake8-bugbear