occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

doc: Refactor manual index, make sections

This commit is contained in:
architeuthidae 2024-07-15 17:17:28 +08:00 committed by Sébastien Bourdeauducq
parent bff46fcf1e
commit c9a4f3b9ee
1 changed files with 37 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/manual/index.rst
View File

@ -1,28 +1,58 @@
ARTIQ documentation ARTIQ manual
=================== ============
.. toctree:: .. toctree::
:caption: Contents :caption: Overview
:maxdepth: 2 :maxdepth: 2
introduction introduction
release_notes release_notes
.. toctree::
:caption: Setting up ARTIQ
:maxdepth: 2
installing installing
developing developing
.. toctree::
:caption: Tutorials
:maxdepth: 2
rtio rtio
getting_started_core getting_started_core
getting_started_mgmt getting_started_mgmt
using_drtio_subkernels using_drtio_subkernels
.. toctree::
:caption: ARTIQ components
:maxdepth: 2
environment environment
compiler compiler
management_system management_system
drtio drtio
core_device core_device
.. toctree::
:caption: Network devices
:maxdepth: 2
developing_a_ndsp
list_of_ndsps
default_network_ports
.. toctree::
:caption: References
:maxdepth: 2
main_frontend_reference main_frontend_reference
core_language_reference core_language_reference
core_drivers_reference core_drivers_reference
utilities utilities
developing_a_ndsp
list_of_ndsps .. toctree::
default_network_ports :caption: Addenda
:maxdepth: 2
faq faq