Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cookiecutter - generate API doc #29

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Cookiecutter - generate API doc #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0830256
Add API doc
bobleesj Nov 1, 2024
d0dd44b
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions doc/source/api/diffpy.nmf_mapping.example_package.rst
View file
Open in desktop

This file was deleted.

26 changes: 12 additions & 14 deletions doc/source/api/diffpy.nmf_mapping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
:tocdepth: -1

|title|
=======

.. |title| replace:: diffpy.nmf_mapping package
diffpy.nmf-mapping package
==========================

.. automodule:: diffpy.nmf_mapping
:members:
:undoc-members:
:show-inheritance:

Subpackages
-----------

.. toctree::
diffpy.nmf_mapping.example_package

Submodules
----------

|module|
--------
diffpy.nmf_mapping.nmf_mapping_code module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.nmf_mapping.nmf_mapping_code
:members:
:undoc-members:
:show-inheritance:

.. |module| replace:: diffpy.nmf_mapping.example_submodule module
diffpy.nmf_mapping.main module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.nmf_mapping.example_submodule
.. automodule:: diffpy.nmf_mapping.main
:members:
:undoc-members:
:show-inheritance:
Loading