From 554265158273f8f699b381ef85598f520461bb7a Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Fri, 4 Oct 2024 18:09:49 -0400 Subject: [PATCH 1/4] redo cookiecutter --- doc/source/api/diffpy.labpdfproc.rst | 34 ++++++++++++---------------- doc/source/conf.py | 2 -- doc/source/installation.rst | 7 ------ doc/source/license.rst | 4 ++-- doc/source/min_versions.rst | 28 ----------------------- doc/source/release-history.rst | 6 ----- doc/source/usage.rst | 9 -------- requirements/README.txt | 2 +- 8 files changed, 17 insertions(+), 75 deletions(-) delete mode 100644 doc/source/installation.rst delete mode 100644 doc/source/min_versions.rst delete mode 100644 doc/source/release-history.rst delete mode 100644 doc/source/usage.rst diff --git a/doc/source/api/diffpy.labpdfproc.rst b/doc/source/api/diffpy.labpdfproc.rst index 4f0a72d..1bcc98d 100644 --- a/doc/source/api/diffpy.labpdfproc.rst +++ b/doc/source/api/diffpy.labpdfproc.rst @@ -1,36 +1,30 @@ :tocdepth: -1 -diffpy.labpdfproc package -========================= +|title| +======= + +.. |title| replace:: diffpy.labpdfproc package .. automodule:: diffpy.labpdfproc :members: :undoc-members: :show-inheritance: -Submodules ----------- - -diffpy.labpdfproc.functions module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Subpackages +----------- -.. automodule:: diffpy.labpdfproc.functions - :members: - :undoc-members: - :show-inheritance: +.. toctree:: + diffpy.labpdfproc.example_package -diffpy.labpdfproc.tools module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Submodules +---------- -.. automodule:: diffpy.labpdfproc.tools - :members: - :undoc-members: - :show-inheritance: +|module| +-------- -diffpy.labpdfproc.labpdfprocapp module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. |module| replace:: diffpy.labpdfproc.example_submodule module -.. automodule:: diffpy.labpdfproc.labpdfprocapp +.. automodule:: diffpy.labpdfproc.example_submodule :members: :undoc-members: :show-inheritance: 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/license.rst b/doc/source/license.rst index 9ae52a9..cfab61c 100644 --- a/doc/source/license.rst +++ b/doc/source/license.rst @@ -9,9 +9,9 @@ OPEN SOURCE LICENSE AGREEMENT ============================= BSD 3-Clause License -Copyright (c) 2024, The Trustees of Columbia University in +Copyright (c) 2024, The Trustees of Columbia University in the City of New York. -All Rights Reserved. +All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 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/requirements/README.txt b/requirements/README.txt index 3de372a..dc34909 100644 --- a/requirements/README.txt +++ b/requirements/README.txt @@ -2,7 +2,7 @@ # # This directory is where you should place your project dependencies. # "pip.txt" should contain all required packages not available on conda. -# All other files should contain only packages available to download from conda. +# All other files should contain only packages available to download from conda. # build.txt should contain all packages required to build (not run) the project. # run.txt should contain all packages (including optional packages) required for a user to run the program. # test.txt should contain all packages required for the testing suite and to ensure all tests pass. From b50e629aea670188d77bc78b5fd7489cc163bde7 Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Fri, 4 Oct 2024 18:14:07 -0400 Subject: [PATCH 2/4] generate package api doc --- doc/source/api/diffpy.labpdfproc.data.rst | 10 +++++ .../api/diffpy.labpdfproc.example_package.rst | 31 -------------- doc/source/api/diffpy.labpdfproc.rst | 41 +++++++++++++++---- 3 files changed, 42 insertions(+), 40 deletions(-) create mode 100644 doc/source/api/diffpy.labpdfproc.data.rst delete mode 100644 doc/source/api/diffpy.labpdfproc.example_package.rst diff --git a/doc/source/api/diffpy.labpdfproc.data.rst b/doc/source/api/diffpy.labpdfproc.data.rst new file mode 100644 index 0000000..5727ee3 --- /dev/null +++ b/doc/source/api/diffpy.labpdfproc.data.rst @@ -0,0 +1,10 @@ +: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 1bcc98d..35b7999 100644 --- a/doc/source/api/diffpy.labpdfproc.rst +++ b/doc/source/api/diffpy.labpdfproc.rst @@ -1,9 +1,7 @@ :tocdepth: -1 -|title| -======= - -.. |title| replace:: diffpy.labpdfproc package +diffpy.labpdfproc package +========================= .. automodule:: diffpy.labpdfproc :members: @@ -14,17 +12,42 @@ Subpackages ----------- .. toctree:: - diffpy.labpdfproc.example_package + :titlesonly: + + diffpy.labpdfproc.data Submodules ---------- -|module| --------- +diffpy.labpdfproc.functions module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. |module| replace:: diffpy.labpdfproc.example_submodule module +.. automodule:: diffpy.labpdfproc.functions + :members: + :undoc-members: + :show-inheritance: -.. automodule:: diffpy.labpdfproc.example_submodule +diffpy.labpdfproc.tools module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.labpdfproc.tools :members: :undoc-members: :show-inheritance: + +diffpy.labpdfproc.mud_calculator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.labpdfproc.mud_calculator + :members: + :undoc-members: + :show-inheritance: + +diffpy.labpdfproc.labpdfprocapp module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.labpdfproc.labpdfprocapp + :members: + :undoc-members: + :show-inheritance: + From b2fe35d0311b17986269beb74e89bc4c82ab8a66 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 22:15:21 +0000 Subject: [PATCH 3/4] [pre-commit.ci] auto fixes from pre-commit hooks --- doc/source/api/diffpy.labpdfproc.data.rst | 1 - doc/source/api/diffpy.labpdfproc.rst | 1 - doc/source/license.rst | 4 ++-- requirements/README.txt | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/source/api/diffpy.labpdfproc.data.rst b/doc/source/api/diffpy.labpdfproc.data.rst index 5727ee3..7ff7501 100644 --- a/doc/source/api/diffpy.labpdfproc.data.rst +++ b/doc/source/api/diffpy.labpdfproc.data.rst @@ -7,4 +7,3 @@ diffpy.labpdfproc.data package :members: :undoc-members: :show-inheritance: - diff --git a/doc/source/api/diffpy.labpdfproc.rst b/doc/source/api/diffpy.labpdfproc.rst index 35b7999..941776e 100644 --- a/doc/source/api/diffpy.labpdfproc.rst +++ b/doc/source/api/diffpy.labpdfproc.rst @@ -50,4 +50,3 @@ diffpy.labpdfproc.labpdfprocapp module :members: :undoc-members: :show-inheritance: - diff --git a/doc/source/license.rst b/doc/source/license.rst index cfab61c..9ae52a9 100644 --- a/doc/source/license.rst +++ b/doc/source/license.rst @@ -9,9 +9,9 @@ OPEN SOURCE LICENSE AGREEMENT ============================= BSD 3-Clause License -Copyright (c) 2024, The Trustees of Columbia University in +Copyright (c) 2024, The Trustees of Columbia University in the City of New York. -All Rights Reserved. +All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/requirements/README.txt b/requirements/README.txt index dc34909..3de372a 100644 --- a/requirements/README.txt +++ b/requirements/README.txt @@ -2,7 +2,7 @@ # # This directory is where you should place your project dependencies. # "pip.txt" should contain all required packages not available on conda. -# All other files should contain only packages available to download from conda. +# All other files should contain only packages available to download from conda. # build.txt should contain all packages required to build (not run) the project. # run.txt should contain all packages (including optional packages) required for a user to run the program. # test.txt should contain all packages required for the testing suite and to ensure all tests pass. From 45e8605a4b8a0338520a7d96cc8a5a64e8a16025 Mon Sep 17 00:00:00 2001 From: yucongalicechen Date: Fri, 4 Oct 2024 18:17:03 -0400 Subject: [PATCH 4/4] add news item --- news/api_doc.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/api_doc.rst 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:** + +*