Skip to content

Commit 1a0714b

Browse files
authored
Merge pull request #29 from bobleesj/api-doc
Cookiecutter - generate API doc
2 parents f72815f + d0dd44b commit 1a0714b

File tree

2 files changed

+12
-45
lines changed

2 files changed

+12
-45
lines changed

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

-31
This file was deleted.

doc/source/api/diffpy.nmf_mapping.rst

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,28 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.nmf_mapping package
3+
diffpy.nmf-mapping package
4+
==========================
75

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

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

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

25-
.. |module| replace:: diffpy.nmf_mapping.example_submodule module
22+
diffpy.nmf_mapping.main module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2624

27-
.. automodule:: diffpy.nmf_mapping.example_submodule
25+
.. automodule:: diffpy.nmf_mapping.main
2826
:members:
2927
:undoc-members:
3028
:show-inheritance:

0 commit comments

Comments
 (0)