Skip to content

Commit c56b044

Browse files
committed
remove files from auto API
1 parent 9ced416 commit c56b044

File tree

3 files changed

+23
-45
lines changed

3 files changed

+23
-45
lines changed

doc/source/api/diffpy.labpdfproc.example_package.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

doc/source/api/diffpy.labpdfproc.rst

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.labpdfproc package
3+
diffpy.labpdfproc package
4+
=========================
75

86
.. automodule:: diffpy.labpdfproc
97
:members:
108
:undoc-members:
119
:show-inheritance:
1210

13-
Subpackages
14-
-----------
15-
16-
.. toctree::
17-
diffpy.labpdfproc.example_package
18-
1911
Submodules
2012
----------
2113

22-
|module|
23-
--------
14+
diffpy.labpdfproc.functions module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.labpdfproc.functions
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
2421

25-
.. |module| replace:: diffpy.labpdfproc.example_submodule module
22+
diffpy.labpdfproc.tools module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2624

27-
.. automodule:: diffpy.labpdfproc.example_submodule
25+
.. automodule:: diffpy.labpdfproc.tools
2826
:members:
2927
:undoc-members:
3028
:show-inheritance:
29+
30+
diffpy.labpdfproc.labpdfprocapp module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.labpdfproc.labpdfprocapp
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+

doc/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
from importlib.metadata import version
1919
from pathlib import Path
2020

21+
autodoc_mock_imports = ['diffpy.utils', 'numpy']
22+
2123
# If extensions (or modules to document with autodoc) are in another directory,
2224
# add these directories to sys.path here. If the directory is relative to the
2325
# documentation root, use Path().resolve() to make it absolute, like shown here.

0 commit comments

Comments
 (0)