diff --git a/doc/source/api/diffpy.labpdfproc.data.rst b/doc/source/api/diffpy.labpdfproc.data.rst new file mode 100644 index 0000000..7ff7501 --- /dev/null +++ b/doc/source/api/diffpy.labpdfproc.data.rst @@ -0,0 +1,9 @@ +:tocdepth: -1 + +diffpy.labpdfproc.data package +============================== + +.. automodule:: diffpy.labpdfproc.data + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/diffpy.labpdfproc.example_package.rst b/doc/source/api/diffpy.labpdfproc.example_package.rst deleted file mode 100644 index 429ad23..0000000 --- a/doc/source/api/diffpy.labpdfproc.example_package.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _example_package documentation: - -|title| -======= - -.. |title| replace:: diffpy.labpdfproc.example_package package - -.. automodule:: diffpy.labpdfproc.example_package - :members: - :undoc-members: - :show-inheritance: - -|foo| ------ - -.. |foo| replace:: diffpy.labpdfproc.example_package.foo module - -.. automodule:: diffpy.labpdfproc.example_package.foo - :members: - :undoc-members: - :show-inheritance: - -|bar| ------ - -.. |bar| replace:: diffpy.labpdfproc.example_package.bar module - -.. automodule:: diffpy.labpdfproc.example_package.foo - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/diffpy.labpdfproc.rst b/doc/source/api/diffpy.labpdfproc.rst index 4f0a72d..941776e 100644 --- a/doc/source/api/diffpy.labpdfproc.rst +++ b/doc/source/api/diffpy.labpdfproc.rst @@ -8,6 +8,14 @@ diffpy.labpdfproc package :undoc-members: :show-inheritance: +Subpackages +----------- + +.. toctree:: + :titlesonly: + + diffpy.labpdfproc.data + Submodules ---------- @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/conf.py b/doc/source/conf.py index 688e25c..8c9095e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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. diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index 9b35fb5..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,7 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install diffpy.labpdfproc diff --git a/doc/source/min_versions.rst b/doc/source/min_versions.rst deleted file mode 100644 index d28e747..0000000 --- a/doc/source/min_versions.rst +++ /dev/null @@ -1,28 +0,0 @@ -=================================== -Minimum Version of Python and NumPy -=================================== - - -- This project supports at least the minor versions of Python - initially released 42 months prior to a planned project release - date. -- The project will always support at least the 2 latest minor - versions of Python. -- The project will support minor versions of ``numpy`` initially - released in the 24 months prior to a planned project release date or - the oldest version that supports the minimum Python version - (whichever is higher). -- The project will always support at least the 3 latest minor - versions of NumPy. - -The minimum supported version of Python will be set to -``python_requires`` in ``setup``. All supported minor versions of -Python will be in the test matrix and have binary artifacts built -for releases. - -The project should adjust upward the minimum Python and NumPy -version support on every minor and major release, but never on a -patch release. - -This is consistent with NumPy `NEP 29 -`__. diff --git a/doc/source/release-history.rst b/doc/source/release-history.rst deleted file mode 100644 index 53707fb..0000000 --- a/doc/source/release-history.rst +++ /dev/null @@ -1,6 +0,0 @@ -=============== -Release History -=============== - -Initial Release (YYYY-MM-DD) ----------------------------- diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 4c19f3d..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,9 +0,0 @@ -===== -Usage -===== - -Start by importing diffpy.labpdfproc. - -.. code-block:: python - - import labpdfproc diff --git a/news/api_doc.rst b/news/api_doc.rst new file mode 100644 index 0000000..5c301ef --- /dev/null +++ b/news/api_doc.rst @@ -0,0 +1,23 @@ +**Added:** + +* generate package API doc + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*