WIP - restructure doc files
This commit is contained in:
parent
5d6abfa8d8
commit
d4b6d9b250
@ -114,8 +114,8 @@ if __name__ == "__main__":
|
|||||||
logging.basicConfig(level=logging.INFO)
|
logging.basicConfig(level=logging.INFO)
|
||||||
docs_root = Path(__file__).parent
|
docs_root = Path(__file__).parent
|
||||||
make_rst(
|
make_rst(
|
||||||
docs_root / ".." / "tianshou" / "highlevel",
|
docs_root / ".." / "tianshou",
|
||||||
docs_root / "api" / "tianshou.highlevel",
|
docs_root / "api" / "tianshou",
|
||||||
clean=True,
|
clean=True,
|
||||||
package_prefix="tianshou.",
|
package_prefix="tianshou.",
|
||||||
)
|
)
|
||||||
|
@ -96,16 +96,9 @@ Tianshou is still under development, you can also check out the documents in sta
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Get started:
|
:caption: Get started:
|
||||||
|
:glob:
|
||||||
|
|
||||||
notebooks/intro
|
notebooks/*
|
||||||
notebooks/L0_overview
|
|
||||||
notebooks/L1_Batch
|
|
||||||
notebooks/L2_Buffer
|
|
||||||
notebooks/L3_Vectorized__Environment
|
|
||||||
notebooks/L4_Policy
|
|
||||||
notebooks/L5_Collector
|
|
||||||
notebooks/L6_Trainer
|
|
||||||
notebooks/L7_Experiment
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
@ -124,14 +117,10 @@ Tianshou is still under development, you can also check out the documents in sta
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:caption: API Docs
|
:caption: API Docs
|
||||||
|
:glob:
|
||||||
|
|
||||||
api/tianshou.data
|
|
||||||
api/tianshou.env
|
api/*
|
||||||
api/tianshou.policy
|
|
||||||
api/tianshou.trainer
|
|
||||||
api/tianshou.exploration
|
|
||||||
api/tianshou.utils
|
|
||||||
api/tianshou.highlevel/index
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
Loading…
x
Reference in New Issue
Block a user