Added updated docstrings

This commit is contained in:
Alejandro Saucedo 2020-08-28 18:39:58 +01:00
parent 85f43c5c8e
commit 6fb99c089b
10 changed files with 334 additions and 72 deletions

View file

@ -52,16 +52,14 @@ add_custom_target(gensphinx ALL
${SPHINX_SOURCE} ${SPHINX_BUILD}
-Dbreathe_projects.Kompute=${DOXYGEN_XML_PATH}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${DOXYGEN_INDEX_FILE}
DEPENDS gendoxygen
COMMENT "Generating documentation with Sphinx")
# For completeness we also copy the output doxygen html files
file(COPY ${DOXYGEN_OUTPUT_DIR}/html/
DESTINATION ${SPHINX_BUILD}/doxygen/)
#add_custom_target(includedoxygen ALL
# COMMAND ${CMAKE_COMMAND}
# -E copy_directory
# ${DOXYGEN_OUTPUT_DIR}/html/
# ${SPHINX_BUILD}/doxygen/
# DEPENDS gensphinx)
add_custom_target(gendocsall ALL
COMMAND ${CMAKE_COMMAND}
-E copy_directory
${DOXYGEN_OUTPUT_DIR}/html/
${SPHINX_BUILD}/doxygen/
DEPENDS gensphinx)

View file

@ -13,24 +13,44 @@ Welcome to Vulkan Kompute's documentation!
:caption: Contents:
Docs
Reference
====
You can also go directoy to the `raw doxygen docs <doxygen/annotated.html>`_
Manager
-------
.. doxygenclass:: kp::Manager
:members:
Sequence
-------
.. doxygenclass:: kp::Sequence
:members:
OpBase
-------
.. doxygenclass:: kp::OpBase
:members:
OpMult
-------
.. doxygenclass:: kp::OpMult
:members:
OpCreateTensor
-------
.. doxygenclass:: kp::OpCreateTensor
:members:
Algorithm
-------
.. doxygenclass:: kp::Algorithm
:members: