adding documentation

docs/Makefile

@@ -0,0 +1,195 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+
+# Options should be aligned with how the documentation is built on RTD
+# (except for '--keep-going', failing fast is preferred on local builds)
+# We also remove '-E' to reduce the time of rebuilding reference indexes
+# on each build.
+SPHINXOPTS    = -T -j auto -W
+SPHINXBUILD   = sphinx-build
+PAPER         =
+PROJECT       ?= webmonchow
+BUILDDIR      = build
+
+# Do not use local Django settings during the docs build
+export DJANGO_SETTINGS_SKIP_LOCAL = True
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+auto:
+	sphinx-autobuild --port 8888 $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+livehtml:
+	sphinx-autobuild --port 4444 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sdf.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sdf.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/sdf"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sdf"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/developer/index.rst

@@ -0,0 +1,106 @@
+.. _developer:
+
+Developer Documentation
+=======================
+
+.. contents::
+   :local:
+   :depth: 1
+
+Local Environment
+-----------------
+For purposes of development, create conda environment `webmonchow` with file `environment.yml`, and then
+install the package in development mode with `pip`:
+
+.. code-block:: bash
+
+   $> cd/path/to/webmonchow/
+   $> conda create env --solver libmamba --file ./environment.yml
+   $> conda activate webmonchow
+   (webmonchow)$> pip install --no-deps -e ./
+
+By installing the package in development mode, one doesn't need to re-install package `usanred` in conda
+environment `webmonchow` after every change to the source code.
+Option `--no-deps` ensures that `pip` does not install additional packages from `pyproject.toml`
+into the development environment.
+
+pre-commit Hooks
+----------------
+
+Activate the hooks by typing in the terminal:
+
+.. code-block:: bash
+
+   $> cd cd /path/to/mr_reduction/
+   $> conda activate mr_reduction
+   (mr_reduction)$> pre-commit install
+
+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. Any new features or bugfixes must be covered by new and/or refactored automated tests.
+5. The developer asks for another developer as a reviewer to review the PR.
+   A PR can only be approved and merged by the reviewer.
+6. The developer changes the task’s status to **Complete** and closes the associated issue.
+
+Running the tests
+-----------------
+Locally running the units tests:
+
+.. code-block:: bash
+
+   $> conda activate webmonchow
+   (webmonchow)$> pytest -v  tests/
+
+Building the python wheel
+-------------------------
+Locally building the python wheel. At the root of the repo:
+
+.. code-block:: bash
+
+   $> conda activate webmonchow
+   (webmonchow)$> python -m build  # generate the wheel
+    (webmonchow)$> twine check dist/*  # check the wheel with twine
+
+Building the conda package
+--------------------------
+Locally building the conda package. At the root of the repo:
+
+.. code-block:: bash
+
+   $> cd conda.recipe/
+   $> conda activate webmonchow
+   (webmonchow)$> conda mambabuild -c conda-forge --output-folder . .
+
+If using `mamba` instead of `conda`, replace `conda mambabuild` with `mamba build`.
+
+
+Building the documentation
+--------------------------
+A repository webhook is setup to automatically trigger the latest documentation build by GitHub actions.
+To manually build the documentation:
+
+.. code-block:: bash
+
+   $> conda activate webmonchow
+   (webmonchow)$> cd /path/to/webmonchow/docs
+   (webmonchow)$> make docs
+
+After this, point your browser to
+`file:///path/to/webmonchow/docs/build/html/index.html`
+
+
+Coverage reports
+----------------
+
+GitHuh actions create reports for unit and integration tests, then combine into one report and upload it to
+`Codecov <https://app.codecov.io/gh/neutrons/webmonchow>`_.
+
+Creating a stable release
+-------------------------
+- Follow the `Software Maturity Model <https://ornl-neutrons.atlassian.net/wiki/spaces/NDPD/pages/23363585/Software+Maturity+Model>`_
+  for continuous versioning as well as creating release candidates and stable releases.
+- Update the :ref:`Release Notes <release_notes>` with major fixes, updates and additions since last stable release.

docs/index.rst

@@ -1,16 +1,19 @@
-=========================================
-Welcome to python project template docs!
-=========================================
+.. _webmonchow_rootdoc:
+
+Welcome to Webmonchow's documentation!
+======================================
+
+Webmonchow is a test fixture to mimic the feed generated by Dasmon, PVSD, and Translation
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
 
-   README
+   user/index
+   developer/index
+   releases
 
-=========================================
 Indices and tables
-=========================================
+==================
 
 * :ref:`genindex`
 * :ref:`modindex`

docs/releases.rst

@@ -0,0 +1,23 @@
+.. _release_notes:
+
+Release Notes
+=============
+Notes for the next major or minor release of `webmonchow`.
+
+
+<Next Major or Minor Release>
+-----------------------------
+(date of release)
+
+**Of interest to the User**:
+
+- PR #XYZ one-liner description
+
+**Of interest to the Developer:**
+
+- PR #XYZ one-liner description
+
+1.0.0
+-----
+Modernization of the repository following the best practices described in the paper
+`Preferred Practices Through a Project Template <https://zenodo.org/records/13357328>`_.