mmrazor/docs/en/index.rst
humu789 93bf46881b
[Doc] Update README.md and fix docs (#270)
* fix docs

* update README.md and model_zoo

* fix lint

* update README.md

* fix lint
2022-09-01 01:15:18 +08:00

56 lines
968 B
ReStructuredText

.. mmrazor documentation master file, created by
sphinx-quickstart on Mon Aug 29 15:21:38 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to mmrazor's documentation!
===================================
.. toctree::
:maxdepth: 1
:caption: Get Started:
get_started/overview.md
get_started/installation.md
get_started/model_zoo.md
.. toctree::
:maxdepth: 2
:caption: User Guides:
user_guides/index.rst
.. toctree::
:maxdepth: 2
:caption: Advanced Guides
advanced_guides/index.rst
.. toctree::
:maxdepth: 1
:caption: Notes
notes/changelog.md
notes/contribution_guide.md
notes/faq.md
.. toctree::
:maxdepth: 1
:caption: APIs Reference
api.rst
.. toctree::
:maxdepth: 1
:caption: Switch Language
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`