add API documentation

* add API documentation Signed-off-by: Jose Borreguero <[email protected]> * add contributing guidelines Signed-off-by: Jose Borreguero <[email protected]> --------- Signed-off-by: Jose Borreguero <[email protected]>
neutrons · Apr 26, 2024 · 41e3d97 · 41e3d97
1 parent 3b42ce5
commit 41e3d97
Show file tree

Hide file tree

Showing 5 changed files with 178 additions and 180 deletions.
diff --git a/README.md b/README.md
@@ -2,32 +2,12 @@
 Backend code for the reduction of USANS data.
 (originally forked from https://code.ornl.gov/rys/usans-reduction/)
 
-5. Having code coverage, `codecov.yaml` is **strongly recommended**, please refer to [Code coverage](https://coverage.readthedocs.io/en/coverage-5.5/) for more information.
-
-
-6. Adjust the demo Github action yaml files for CI/CD. For more information about Github action, please refer to [Github action](https://docs.github.com/en/actions).
-
-    6.1 Specify package name at: .github/workflows/package.yml#L34
-
-    6.2 Specify package name at: .github/workflows/package.yml#L46
-
-
-8. Adjust `pyproject.toml` to match your project. For more information about `pyproject.toml`, please refer to [pyproject.toml](https://www.python.org/dev/peps/pep-0518/).
-
-    8.1 Specify package name at: pyproject.toml#L2
-
-    8.2 Specify package description at: pyproject.toml#L3
-
-    8.3 Specify package name at: pyproject.toml#L40
-
-    8.4 We strongly recommended using a single `pyproject.toml` file to manage all the project metadata, including the project name, version, author, license, etc.
-
-    8.5 Python is moving away from `setup.cfg`/`setup.py`, and we would like to follow the trend for our new projects.
-
-
-11. Clear the content of this file and add your own README.md as the project README file. We recommend putting badges of the project status at the top of the README file. For more information about badges, please refer to [shields.io](https://shields.io/).
+# User
 
+User guide at [readthedocs](https://usansred.readthedocs.io/en/latest/source/user.html)
 
 # Developer
 
-Developer documentation at [readthedocs]()https://usansred.readthedocs.io/en/latest/source/developer.html
+Developer documentation at [readthedocs](https://usansred.readthedocs.io/en/latest/source/developer.html)
+
+- [contributing to the project](https://usansred.readthedocs.io/en/latest/source/contributing.html)
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,12 +12,21 @@ User Guide
    /source/user/conda_environments
    /source/user/reduce
 
+API
+---
+
+.. toctree::
+   :titlesonly:
+
+   /source/api/usansred
+
 Developer Guide
 ---------------
 
 .. toctree::
    :titlesonly:
 
+   /source/developer/contributing
    /source/developer/developer
 
 Contents

diff --git a/docs/source/api/usansred.rst b/docs/source/api/usansred.rst
@@ -0,0 +1,44 @@
+.. api_usansred
+
+usansred package
+================
+
+Submodules
+----------
+
+.. (include explicit links to sections because toctree doesn't work)
+
+- :ref:`usansred-reduce`
+- :ref:`usansred-reduce-usans`
+- :ref:`usansred-summary`
+
+
+.. _usansred-reduce:
+
+usansred.reduce
+---------------
+
+.. automodule:: usansred.reduce
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. _usansred-reduce-usans:
+
+usansred.reduce\_USANS
+----------------------
+
+.. automodule:: usansred.reduce_USANS
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. _usansred-summary:
+
+usansred.summary
+----------------
+
+.. automodule:: usansred.summary
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/developer/contributing.rst b/docs/source/developer/contributing.rst
@@ -0,0 +1,43 @@
+.. contributing
+
+Guide to Contributing
+=====================
+
+Contributions to this project are welcome. All contributors agree to the following:
+
+- It is assumed that the contributor is an ORNL employee and belongs to the development team.
+  Thus the following instructions are specific to ORNL development team's process.
+- You have permission and any required rights to submit your contribution.
+- Your contribution is provided under the license of this project and may be redistributed as such.
+- All contributions to this project are public.
+
+All contributions must be "signed off" in the commit log and by doing so you agree to the above.
+
+Getting access to the main project
+----------------------------------
+Direct commit access to the project is currently restricted to core developers.
+All other contributions should be done through pull requests.
+
+
+Development procedure
+---------------------
+
+1. A developer is assigned with a task during neutron status meeting and changes the task's status to **In Progress**.
+2. The developer creates a branch off *next* and completes the task in this branch.
+3. The developer creates a pull request (PR) off *next*.
+4. The developer asks for another developer as a reviewer to review the PR.
+   A PR can only be approved and merged by the reviewer.
+5. The developer changes the task’s status to **Complete** and closes the associated issue.
+
+
+Contacting the Team
+-------------------
+The best mechanism for a user to request a change is to contact the SANS CIS.
+Please email `Yingrui Shang`_ with your request.
+
+.. _Yingrui Shang: [email protected]
+
+A change needs to be in the form of a:
+
+- Story for any enhancement request
+- Defect for any bug fix request.