WIP - restructure doc files

docs/.gitignore

@@ -1,2 +1,2 @@
-/api/tianshou.highlevel
+/api/*
 jupyter_execute

docs/_config.yml

@@ -93,7 +93,7 @@ repository:
 #######################################################################################
 # Advanced and power-user settings
 sphinx:
-  extra_extensions          :   # A list of extra extensions to load by Sphinx (added to those already used by JB).
+  extra_extensions          :   ['sphinx.ext.autodoc']
   local_extensions          :   # A list of local extensions to load by sphinx specified by "name: path" items
   recursive_update          : false # A boolean indicating whether to overwrite the Sphinx config (true) or recursively update (false)
   config                    :   # key-value pairs to directly over-ride the Sphinx configuration

docs/_toc.yml

@@ -6,33 +6,13 @@ root: index
 parts:
 - caption: Get started!
   chapters:
-    - file: notebooks/intro
+    - glob: notebooks/*
-    - file: notebooks/L0_overview
-    - file: notebooks/L1_Batch
-    - file: notebooks/L2_Buffer
-    - file: notebooks/L3_Vectorized__Environment
-    - file: notebooks/L4_Policy
-    - file: notebooks/L5_Collector
-    - file: notebooks/L6_Trainer
-    - file: notebooks/L7_Experiment
 - caption: Tutorials
   chapters:
-    - file: tutorials/dqn
+    - glob: tutorials/*
-    - file: tutorials/concepts
-    - file: tutorials/batch
-    - file: tutorials/tictactoe
-    - file: tutorials/logger
-    - file: tutorials/benchmark
-    - file: tutorials/cheatsheet
 - caption: API
   chapters:
-  - file: api/tianshou.data.rst
+  - glob: api/*
-  - file: api/tianshou.env.rst
-  - file: api/tianshou.policy.rst
-  - file: api/tianshou.trainer.rst
-  - file: api/tianshou.exploration.rst
-  - file: api/tianshou.utils.rst
-  - file: api/tianshou.highlevel/index.rst
 - caption: Community
   chapters:
   - file: contributing

docs/autogen_rst.py

@@ -28,9 +28,6 @@ def package_template(package_qualname: str):
    :members:
    :undoc-members:
 
-.. toctree::
-   :glob:
-
    {package_name}/*
 """
 
@@ -115,7 +112,6 @@ if __name__ == "__main__":
     docs_root = Path(__file__).parent
     make_rst(
         docs_root / ".." / "tianshou",
-        docs_root / "api" / "tianshou",
+        docs_root / "api" ,
         clean=True,
-        package_prefix="tianshou.",
     )

docs/index.rst

@@ -63,7 +63,8 @@ Here is Tianshou's other features:
 Installation
 ------------
 
-Tianshou is currently hosted on `PyPI <https://pypi.org/project/tianshou/>`_ and `conda-forge <https://github.com/conda-forge/tianshou-feedstock>`_. It requires Python >= 3.11.
+Tianshou is currently hosted on `PyPI <https://pypi.org/project/tianshou/>`_ and `conda-forge <https://github.com/conda-forge/tianshou-feedstock>`_. New releases
+(and the current state of the master branch) will require Python >= 3.11.
 
 You can simply install Tianshou from PyPI with the following command:
 
@@ -104,14 +105,9 @@ Tianshou is still under development, you can also check out the documents in sta
 .. toctree::
    :maxdepth: 1
    :caption: Tutorials
+   :glob:
 
-   tutorials/dqn
+   tutorials/*
-   tutorials/concepts
-   tutorials/batch
-   tutorials/tictactoe
-   tutorials/logger
-   tutorials/benchmark
-   tutorials/cheatsheet
 
 
 .. toctree::

pyproject.toml

@@ -80,7 +80,7 @@ pytest = "*"
 pytest-cov = "*"
 # Ray currently causes issues when installed on windows server 2022 in CI
 # If users want to use ray, they should install it manually.
-ray = {version = "^2", markers = "sys_platform != 'win32'"}
+ray = { version = "^2", markers = "sys_platform != 'win32'" }
 ruff = "^0.0.285"
 scipy = "*"
 sphinx = "<7"
@@ -159,6 +159,8 @@ max-complexity = 20
 [tool.poetry-sort]
 move-optionals-to-bottom = true
 
+[tool.poe.env]
+PYDEVD_DISABLE_FILE_VALIDATION="1"
 # keep relevant parts in sync with pre-commit
 [tool.poe.tasks]  # https://github.com/nat-n/poethepoet
 test = "pytest test --cov=tianshou --cov-report=xml --cov-report=term-missing --durations=0 -v --color=yes"
@@ -174,8 +176,8 @@ _clean-nbs = "nbstripout docs/notebooks/*"
 format = ["_black_format", "_ruff_format", "_poetry_install_sort_plugin", "_poetry_sort", "_clean-nbs"]
 _autogen_rst = "python docs/autogen_rst.py"
 _spellcheck = "sphinx-build -b spelling docs docs/_build"
-_doc_build = "sphinx-build -b html docs docs/_build"
+_sphinx_build = "sphinx-build -b html docs docs/_build"
- _jb_config = "jupyter-book config sphinx docs/"
+_jb_config = "jupyter-book config sphinx docs/"
 doc-clean = "rm -rf docs/_build"
-doc-build = ["_autogen_rst", " _jb_config", "_spellcheck", "_doc_build"]
+doc-build = ["_autogen_rst", " _jb_config", "_sphinx_build"]
 type-check = "mypy tianshou"