Skip to content

Commit

Permalink
Add ContoursProfiler to API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cverstege committed Dec 16, 2024
1 parent 7e57077 commit d3cfb14
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 14 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
Expand Down
6 changes: 3 additions & 3 deletions doc/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
:robots: index, follow


#######################
**kafe2** documentation
#######################
###################
kafe2 documentation
###################

.. image:: _static/img/badge_kafe2.svg.png
:width: 128px
Expand Down
29 changes: 19 additions & 10 deletions doc/src/parts/api_documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Tools for Fitting Histograms: :py:mod:`~kafe2.fit.histogram`


Tools for Unbinned Fits: :py:mod:`~kafe2.fit.unbinned`
------------------------------------------------------------
------------------------------------------------------

.. automodule:: kafe2.fit.unbinned
:members:
Expand All @@ -94,14 +94,23 @@ Abstract Base Classes: :py:mod:`~kafe2.fit._base`
:undoc-members:
:imported-members:
:show-inheritance:



.. Core functionality: :py:mod:`~kafe2.core`
.. =========================================
..
.. .. automodule:: kafe2.core
.. :members:
.. :undoc-members:
.. :show-inheritance:
..

Additional functionality: :py:mod:`~kafe2.fit.tools`
====================================================

.. automodule:: kafe2.fit.tools
:members:
:undoc-members:
:show-inheritance:


Likelihood Scans and Contours: :py:mod:`~kafe2.fit.tools.contours_profiler`
---------------------------------------------------------------------------

.. automodule:: kafe2.fit.tools.contours_profiler
:members:
:undoc-members:
:imported-members:
:show-inheritance:

0 comments on commit d3cfb14

Please sign in to comment.