From cce7d3d30037aec70771aaffed720c4a2cb6a0b5 Mon Sep 17 00:00:00 2001 From: Alexey Shkarin Date: Sun, 8 Oct 2023 13:36:31 +0200 Subject: [PATCH] Excluded C extensions from Sphinx apidoc --- docs/.apidoc/pylablib.core.dataproc.rst | 9 --------- docs/.apidoc/pylablib.devices.Andor.rst | 9 --------- docs/.apidoc/pylablib.devices.Basler.rst | 9 --------- docs/.apidoc/pylablib.devices.IMAQdx.rst | 9 --------- docs/.apidoc/pylablib.devices.PCO.rst | 9 --------- docs/.apidoc/pylablib.devices.SiliconSoftware.rst | 9 --------- docs/apidoc_noautogen.py | 3 ++- 7 files changed, 2 insertions(+), 55 deletions(-) diff --git a/docs/.apidoc/pylablib.core.dataproc.rst b/docs/.apidoc/pylablib.core.dataproc.rst index db38709..af16573 100644 --- a/docs/.apidoc/pylablib.core.dataproc.rst +++ b/docs/.apidoc/pylablib.core.dataproc.rst @@ -13,15 +13,6 @@ pylablib.core.dataproc.callable module :undoc-members: :show-inheritance: -pylablib.core.dataproc.ctransform module ----------------------------------------- - -.. automodule:: pylablib.core.dataproc.ctransform - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - pylablib.core.dataproc.ctransform\_fallback module -------------------------------------------------- diff --git a/docs/.apidoc/pylablib.devices.Andor.rst b/docs/.apidoc/pylablib.devices.Andor.rst index 38ea0d4..4205b1e 100644 --- a/docs/.apidoc/pylablib.devices.Andor.rst +++ b/docs/.apidoc/pylablib.devices.Andor.rst @@ -49,15 +49,6 @@ pylablib.devices.Andor.base module :undoc-members: :show-inheritance: -pylablib.devices.Andor.utils module ------------------------------------ - -.. automodule:: pylablib.devices.Andor.utils - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/.apidoc/pylablib.devices.Basler.rst b/docs/.apidoc/pylablib.devices.Basler.rst index accbc66..636191b 100644 --- a/docs/.apidoc/pylablib.devices.Basler.rst +++ b/docs/.apidoc/pylablib.devices.Basler.rst @@ -13,15 +13,6 @@ pylablib.devices.Basler.pylon module :undoc-members: :show-inheritance: -pylablib.devices.Basler.utils module ------------------------------------- - -.. automodule:: pylablib.devices.Basler.utils - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/.apidoc/pylablib.devices.IMAQdx.rst b/docs/.apidoc/pylablib.devices.IMAQdx.rst index 07225f3..9aa0e86 100644 --- a/docs/.apidoc/pylablib.devices.IMAQdx.rst +++ b/docs/.apidoc/pylablib.devices.IMAQdx.rst @@ -13,15 +13,6 @@ pylablib.devices.IMAQdx.IMAQdx module :undoc-members: :show-inheritance: -pylablib.devices.IMAQdx.utils module ------------------------------------- - -.. automodule:: pylablib.devices.IMAQdx.utils - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/.apidoc/pylablib.devices.PCO.rst b/docs/.apidoc/pylablib.devices.PCO.rst index d5bb7a7..5ca623d 100644 --- a/docs/.apidoc/pylablib.devices.PCO.rst +++ b/docs/.apidoc/pylablib.devices.PCO.rst @@ -13,15 +13,6 @@ pylablib.devices.PCO.SC2 module :undoc-members: :show-inheritance: -pylablib.devices.PCO.utils module ---------------------------------- - -.. automodule:: pylablib.devices.PCO.utils - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/.apidoc/pylablib.devices.SiliconSoftware.rst b/docs/.apidoc/pylablib.devices.SiliconSoftware.rst index 3d6cdd1..ff8a390 100644 --- a/docs/.apidoc/pylablib.devices.SiliconSoftware.rst +++ b/docs/.apidoc/pylablib.devices.SiliconSoftware.rst @@ -13,15 +13,6 @@ pylablib.devices.SiliconSoftware.fgrab module :undoc-members: :show-inheritance: -pylablib.devices.SiliconSoftware.utils module ---------------------------------------------- - -.. automodule:: pylablib.devices.SiliconSoftware.utils - :members: - :inherited-members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/apidoc_noautogen.py b/docs/apidoc_noautogen.py index 74d0ea3..529aeea 100644 --- a/docs/apidoc_noautogen.py +++ b/docs/apidoc_noautogen.py @@ -31,5 +31,6 @@ def get_c_files(): for ln in skip_files: f.write(ln+"\n") + skip_files_pattern=[(f[:-1]+"*" if f.endswith(".c") else f) for f in skip_files] os.environ["SPHINX_APIDOC_OPTIONS"]="members,inherited-members,undoc-members,show-inheritance" # include inherited members into the docstring - subprocess.call(["sphinx-apidoc","-o",".apidoc",src]+skip_files) \ No newline at end of file + subprocess.call(["sphinx-apidoc","-o",".apidoc",src]+skip_files_pattern) \ No newline at end of file