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.

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

Generate Package API doc #106

Merged
merged 5 commits into from
Oct 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions doc/source/api/diffpy.labpdfproc.data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:tocdepth: -1

diffpy.labpdfproc.data package
==============================

.. automodule:: diffpy.labpdfproc.data
:members:
:undoc-members:
:show-inheritance:
31 changes: 0 additions & 31 deletions doc/source/api/diffpy.labpdfproc.example_package.rst

This file was deleted.

16 changes: 16 additions & 0 deletions doc/source/api/diffpy.labpdfproc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ diffpy.labpdfproc package
:undoc-members:
:show-inheritance:

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

.. toctree::
:titlesonly:

diffpy.labpdfproc.data

Submodules
----------

Expand All @@ -27,6 +35,14 @@ diffpy.labpdfproc.tools module
:undoc-members:
:show-inheritance:

diffpy.labpdfproc.mud_calculator module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.labpdfproc.mud_calculator
:members:
:undoc-members:
:show-inheritance:

diffpy.labpdfproc.labpdfprocapp module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 0 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
from importlib.metadata import version
from pathlib import Path

autodoc_mock_imports = ["diffpy.utils", "numpy"]

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use Path().resolve() to make it absolute, like shown here.
Expand Down
7 changes: 0 additions & 7 deletions doc/source/installation.rst

This file was deleted.

28 changes: 0 additions & 28 deletions doc/source/min_versions.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/source/release-history.rst

This file was deleted.

9 changes: 0 additions & 9 deletions doc/source/usage.rst

This file was deleted.

23 changes: 23 additions & 0 deletions news/api_doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* generate package API doc

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>