Skip to content

Commit

Permalink
Excluded C extensions from Sphinx apidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexShkarin committed Oct 8, 2023
1 parent 3b3bc12 commit cce7d3d
Show file tree
Hide file tree
Showing 7 changed files with 2 additions and 55 deletions.
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.core.dataproc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------------------

Expand Down
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.devices.Andor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.devices.Basler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.devices.IMAQdx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.devices.PCO.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
9 changes: 0 additions & 9 deletions docs/.apidoc/pylablib.devices.SiliconSoftware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------

Expand Down
3 changes: 2 additions & 1 deletion docs/apidoc_noautogen.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
subprocess.call(["sphinx-apidoc","-o",".apidoc",src]+skip_files_pattern)

0 comments on commit cce7d3d

Please sign in to comment.