Files
concrete/docs/index.rst
Benoit Chevallier-Mames 6d43ab81a9 doc: let's document the framework
refs #143
2021-09-09 14:23:38 +02:00

61 lines
1.2 KiB
ReStructuredText

Homomorphic Development Kit's documentation
===========================================
.. toctree::
:maxdepth: 2
:caption: Basics
README.md
install/INSTALLING.md
install/DOCKER.md
.. toctree::
:maxdepth: 2
:caption: Tutorial
user/tutorial/FIRST_TUTORIAL.md
user/tutorial/SECOND_TUTORIAL.md
user/tutorial/THIRD_TUTORIAL.md
.. toctree::
:maxdepth: 2
:caption: How to
user/howto/COMPILE.md
user/howto/REDUCE_NEEDED_PRECISION.md
user/howto/DEBUG_SUPPORT_SUBMIT_ISSUES.md
user/howto/FAQ.md
.. toctree::
:maxdepth: 2
:caption: Explanation
user/explanation/WHAT_IS_FHE.md
user/explanation/FHE_LIMITS.md
user/explanation/QUANTIZATION.md
user/explanation/FUTURE_FEATURES.md
.. toctree::
:maxdepth: 5
:caption: Reference
API <_apidoc/modules.rst>
.. toctree::
:maxdepth: 2
:caption: Developper - How To
dev/howto/DOCUMENTING.md
Releasing on GitHub <dev/howto/RELEASING.md>
dev/howto/CONTRIBUTING.md
.. toctree::
:maxdepth: 2
:caption: Developper - Explanation
dev/explanation/COMPILATION.md
dev/explanation/TERMINOLOGY_AND_STRUCTURE.md
dev/explanation/FLOAT-FUSING.md
dev/explanation/MLIR.md