docs: add first documentation

This commit is contained in:
aquint-zama
2021-11-18 10:56:07 +01:00
committed by Ayoub Benaissa
parent a1a694a686
commit 7f88d6553e
75 changed files with 4313 additions and 16 deletions

View File

@@ -0,0 +1,50 @@
Conversion
==========
HLFHETensorOpsToLinalg:
^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/HLFHETensorOpsToLinalg/Pass.h
HLFHEToMidLFHE:
^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Patterns.h
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Pass.h
MidLFHEGlobalParametrization:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/MidLFHEGlobalParametrization/Pass.h
MidLFHEToLowLFHE:
^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Patterns.h
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Pass.h
LowLFHEToStd:
^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/LowLFHEToConcreteCAPI/Pass.h
.. doxygenfile:: zamalang/Conversion/LowLFHEUnparametrize/Pass.h
.. doxygenfile:: zamalang/Conversion/MLIRLowerableDialectsToLLVM/Pass.h
Utils:
^^^^^^
.. doxygenfile:: zamalang/Conversion/Utils/TensorOpTypeConversion.h
.. doxygenfile:: zamalang/Conversion/Utils/LinalgGenericTypeConverterPattern.h
.. doxygenfile:: zamalang/Conversion/Utils/GenericOpTypeConversionPattern.h
.. doxygenfile:: zamalang/Conversion/Utils/GlobalFHEContext.h

13
docs/cpp_api/index.rst Normal file
View File

@@ -0,0 +1,13 @@
.. _api:
API
===
.. See https://breathe.readthedocs.io/en/latest/directives.html#doxygenfile for more info
.. on doxygen sphinx format
.. toctree::
:glob:
:maxdepth: 2
*

8
docs/cpp_api/runtime.rst Normal file
View File

@@ -0,0 +1,8 @@
Runtime
=======
.. toctree::
:glob:
:maxdepth: 2
runtime/*

View File

@@ -0,0 +1,4 @@
Context:
========
.. doxygenfile:: zamalang/Runtime/context.h

View File

@@ -0,0 +1,8 @@
DataflowRuntime:
================
.. doxygenfile:: zamalang/Runtime/DFRuntime.hpp
Debug interface:
^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Runtime/dfr_debug_interface.h

View File

@@ -0,0 +1,4 @@
Distributed generic task server:
================================
.. doxygenfile:: zamalang/Runtime/distributed_generic_task_server.hpp

View File

@@ -0,0 +1,4 @@
Key Manager:
============
.. doxygenfile:: zamalang/Runtime/key_manager.hpp

View File

@@ -0,0 +1,4 @@
Runtime API:
============
.. doxygenfile:: zamalang/Runtime/runtime_api.h

View File

@@ -0,0 +1,4 @@
Wrappers:
=========
.. doxygenfile:: zamalang/Runtime/wrappers.h

8
docs/cpp_api/support.rst Normal file
View File

@@ -0,0 +1,8 @@
Support
=======
.. toctree::
:glob:
:maxdepth: 2
support/*

View File

@@ -0,0 +1,28 @@
Bonus:
======
Logging:
^^^^^^^^
.. doxygenfile:: logging.h
Math:
^^^^^
.. doxygenfile:: math.h
V0Curves:
^^^^^^^^^
.. doxygenfile:: V0Curves.h
V0Parameters:
^^^^^^^^^^^^^
.. doxygenfile:: V0Parameters.h
Error:
^^^^^^
.. doxygenfile:: Error.h

View File

@@ -0,0 +1,4 @@
ClientParameters:
===============
.. doxygenfile:: ClientParameters.h

View File

@@ -0,0 +1,4 @@
CompilerEngine:
===============
.. doxygenfile:: zamalang/Support/CompilerEngine.h

View File

@@ -0,0 +1,5 @@
Jit:
====
.. doxygenfile:: Jit.h
.. doxygenfile:: JitCompilerEngine.h

View File

@@ -0,0 +1,5 @@
KeySet:
=======
.. doxygenfile:: KeySet.h
.. doxygenfile:: KeySetCache.h

View File

@@ -0,0 +1,4 @@
LambdaArgument:
===============
.. doxygenfile:: LambdaArgument.h

View File

@@ -0,0 +1,4 @@
LLVMEmitFile:
=============
.. doxygenfile:: LLVMEmitFile.h

View File

@@ -0,0 +1,4 @@
Pipeline:
=========
.. doxygenfile:: Pipeline.h