chore: reorganize docs structure

metaopt · Jul 19, 2022 · 7210c0d · 7210c0d
1 parent 6424cad
commit 7210c0d
Show file tree

Hide file tree

Showing 20 changed files with 20 additions and 9 deletions.
diff --git 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
@@ -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
@@ -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 → docs/source/_static/css/style.css b/docs/_static/css/style.css → docs/source/_static/css/style.css
diff --git a/docs/_static/images/logo-torchopt.pdf → docs/source/_static/images/logo-torchopt.pdf b/docs/_static/images/logo-torchopt.pdf → docs/source/_static/images/logo-torchopt.pdf
diff --git a/docs/_static/images/logod-05.png → docs/source/_static/images/logod-05.png b/docs/_static/images/logod-05.png → docs/source/_static/images/logod-05.png
diff --git a/docs/_static/images/logod-07.png → docs/source/_static/images/logod-07.png b/docs/_static/images/logod-07.png → docs/source/_static/images/logod-07.png
diff --git a/docs/_static/images/maml-accs.png → docs/source/_static/images/maml-accs.png b/docs/_static/images/maml-accs.png → docs/source/_static/images/maml-accs.png
diff --git a/docs/_static/js/copybutton.js → docs/source/_static/js/copybutton.js b/docs/_static/js/copybutton.js → docs/source/_static/js/copybutton.js
diff --git a/docs/api/api.rst → docs/source/api/api.rst b/docs/api/api.rst → docs/source/api/api.rst
diff --git a/docs/bibtex.json → docs/source/bibtex.json b/docs/bibtex.json → docs/source/bibtex.json
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → 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 → docs/source/developer/contributing.rst b/docs/developer/contributing.rst → 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 → docs/source/developer/contributor.rst b/docs/developer/contributor.rst → docs/source/developer/contributor.rst
diff --git a/docs/examples/MAML.rst → docs/source/examples/MAML.rst b/docs/examples/MAML.rst → docs/source/examples/MAML.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/refs.bib → docs/source/refs.bib b/docs/refs.bib → docs/source/refs.bib
diff --git a/docs/spelling_wordlist.txt → docs/source/spelling_wordlist.txt b/docs/spelling_wordlist.txt → docs/source/spelling_wordlist.txt
diff --git a/docs/torchopt101/torchopt-101.rst → docs/source/torchopt101/torchopt-101.rst b/docs/torchopt101/torchopt-101.rst → docs/source/torchopt101/torchopt-101.rst
diff --git 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