Merge branch 'doc'

.gitignore

@@ -5,6 +5,7 @@
 .ipynb_checkpoints/
 \#*
 
+docs/_build/
 runinfo/
 plot/
 plotting/plot/

docs/api.rst

@@ -3,5 +3,106 @@ API
 
 .. autosummary::
    :toctree: generated
+   BTVNanoCommissioning.utils.correction
+   BTVNanoCommissioning.utils.selection
+   BTVNanoCommissioning.utils.array_writer
+   BTVNanoCommissioning.utils.histogrammer
+   BTVNanoCommissioning.utils.sample
+   BTVNanoCommissioning.utils.plot_utils
+   BTVNanoCommissioning.helpers.update_branch
+   BTVNanoCommissioning.helpers.func
+   BTVNanoCommissioning.helpers.BTA_helper
+   BTVNanoCommissioning.helpers.xs_scaler
 
-   lumache
+
+
+
+Details
+=======
+
+BTVNanoCommissioning.utils.correction
+-------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.correction
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.utils.selection
+------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.selection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.utils.AK4_parameters
+-----------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.AK4_parameters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.utils.array_writer
+---------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.array_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.utils.histogrammer
+---------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.histogrammer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.utils.sample
+---------------------------------
+.. automodule:: BTVNanoCommissioning.utils.sample
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+BTVNanoCommissioning.utils.plot_utils
+-------------------------------------
+.. automodule:: BTVNanoCommissioning.utils.plot_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.helpers.update_branch
+------------------------------------------
+.. automodule:: BTVNanoCommissioning.helpers.update_branch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.helpers.func
+---------------------------------
+.. automodule:: BTVNanoCommissioning.helpers.func
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.helpers.BTA_helper
+---------------------------------------
+.. automodule:: BTVNanoCommissioning.helpers.BTA_helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.helpers.xs_scaler
+--------------------------------------
+.. automodule:: BTVNanoCommissioning.helpers.xs_scaler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+BTVNanoCommissioning.helpers.xsection
+-------------------------------------
+.. automodule:: BTVNanoCommissioning.helpers.xsection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+scripts.

docs/auto.md

@@ -0,0 +1,5 @@
+## Automation
+
+
+At the moment the automation is limited with the computing resources using gitlab ci [autobtv](https://gitlab.cern.ch/cms-analysis/btv/software-and-algorithms/autobtv). 
+

docs/conf.py

@@ -10,29 +10,52 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os, sys
+
+sys.path.insert(0, os.path.abspath("../src"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = "Basic Sphinx Example Project"
-copyright = "2022, Read the Docs core team"
-author = "Read the Docs core team"
+project = "BTVNanocommissioning"
+copyright = "2024, BTV-POG-CMS"
+author = "By BTV CMS"
 
 
 # -- General configuration ---------------------------------------------------
 # -- General configuration
 
 extensions = [
+    "myst_parser",
+    "sphinx_copybutton",
     "sphinx.ext.duration",
     "sphinx.ext.doctest",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.imgmath",
+    "sphinx.ext.todo",
+]
+
+myst_heading_anchors = 4
+myst_enable_extensions = [
+    "amsmath",
+    "attrs_inline",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "replacements",
+    "smartquotes",
+    "strikethrough",
+    "substitution",
+    "tasklist",
 ]
 
+
 intersphinx_mapping = {
     "rtd": ("https://docs.readthedocs.io/en/stable/", None),
     "python": ("https://docs.python.org/3/", None),
@@ -44,6 +67,8 @@
 
 # -- Options for EPUB output
 epub_show_urls = "footnote"
+source_suffix = [".rst", ".md"]
+copybutton_exclude = ".linenos, .gp"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -61,3 +86,4 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_theme_options = {"style_nav_header_background": "#fcb302"}