Merge pull request #51 from 8bitsam/cookie-api-build

Cookiecutting - build docs api

Author: sbillinge

.github/workflows/docs.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - cookie # to be removed during merge to main
   release:
 
 jobs:

LICENSE.rst

@@ -1,3 +1,6 @@
+License
+#######
+
 This program is part of the DiffPy and DANSE open-source projects
 and is available subject to the conditions and terms laid out below.
 

doc/epydoc/Makefile

@@ -1,30 +1,33 @@
 :tocdepth: -1
 
-|title|
-=======
-
-.. |title| replace:: diffpy.pdffit2 package
+diffpy.pdffit2 package
+======================
 
 .. automodule:: diffpy.pdffit2
     :members:
     :undoc-members:
     :show-inheritance:
 
-Subpackages
------------
+diffpy.pdffit2.ipy_ext module
+-----------------------------
 
-.. toctree::
-   diffpy.pdffit2.example_package
+.. automodule:: diffpy.pdffit2.ipy_ext
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-Submodules
-----------
+diffpy.pdffit2.pdffit module
+-----------------------------
 
-|module|
---------
+.. automodule:: diffpy.pdffit2.pdffit
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. |module| replace:: diffpy.pdffit2.example_submodule module
+diffpy.pdffit2.output module
+-----------------------------
 
-.. automodule:: diffpy.pdffit2.example_submodule
+.. automodule:: diffpy.pdffit2.output
     :members:
     :undoc-members:
     :show-inheritance:

doc/epydoc/epydoc.cfg

@@ -18,6 +18,9 @@
 from importlib.metadata import version
 from pathlib import Path
 
+# Eliminate autodoc warning
+autodoc_mock_imports = ["diffpy.pdffit2"]
+
 # 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.

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

@@ -2,38 +2,4 @@
 
 .. index:: license
 
-License
-#######
-
-OPEN SOURCE LICENSE AGREEMENT
-=============================
-BSD 3-Clause License
-
-Copyright (c) 2024, The Trustees of Columbia University in 
-the City of New York.
-All Rights Reserved. 
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.. include:: ../../LICENSE.rst