add pydoc

emsec · Jun 4, 2024 · 9db66cf · 9db66cf
1 parent 4cb3085
commit 9db66cf
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/plugins/xilinx_toolbox/CMakeLists.txt b/plugins/xilinx_toolbox/CMakeLists.txt
@@ -1,5 +1,7 @@
 option(PL_XILINX_TOOLBOX "PL_XILINX_TOOLBOX" OFF)
+
 if(PL_XILINX_TOOLBOX OR BUILD_ALL_PLUGINS)
+
     file(GLOB_RECURSE XILINX_TOOLBOX_INC ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h)
     file(GLOB_RECURSE XILINX_TOOLBOX_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
     file(GLOB_RECURSE XILINX_TOOLBOX_PYTHON_SRC ${CMAKE_CURRENT_SOURCE_DIR}/python/*.cpp)
@@ -8,5 +10,6 @@ if(PL_XILINX_TOOLBOX OR BUILD_ALL_PLUGINS)
                    SHARED
                    HEADER ${XILINX_TOOLBOX_INC}
                    SOURCES ${XILINX_TOOLBOX_SRC} ${XILINX_TOOLBOX_PYTHON_SRC}
-                   )
+                   PYDOC SPHINX_DOC_INDEX_FILE ${CMAKE_CURRENT_SOURCE_DIR}/documentation/xilinx_toolbox.rst
+                )
 endif()
diff --git a/plugins/xilinx_toolbox/documentation/xilinx_toolbox.rst b/plugins/xilinx_toolbox/documentation/xilinx_toolbox.rst
@@ -0,0 +1,8 @@
+Xilinx Toolbox
+==========================
+
+.. automodule:: xilinx_toolbox
+    :members: split_luts, split_shift_registers, parse_xdc_file
+
+.. autoclass:: xilinx_toolbox.XilinxToolboxPlugin
+    :members: