Skip to content

Commit

Permalink
Merge pull request #98 from zfit/docs/fixrtd
Browse files Browse the repository at this point in the history
docs: add docs
  • Loading branch information
jonas-eschle authored Nov 8, 2024
2 parents cae79a5 + 4540dc2 commit 6a8ae3d
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 8 deletions.
9 changes: 6 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
python: "3.9"



# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -17,7 +19,8 @@ formats: [ ]

python:
install:
- requirements: requirements_dev.txt
- requirements: requirements.txt
- requirements: docs/additional_requirements.txt
- method: pip
path: .
extra_requirements:
- dev
2 changes: 2 additions & 0 deletions docs/additional_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
https://root-experimental-python-wheels.web.cern.ch/ROOT-0.1a5-cp39-cp39-manylinux_2_28_x86_64.whl#sha256=fb3c9c68a4e90d28106c660c2947b8364a18ce59689517a7f4819ab2c8acb40f
tfpwa @ git+https://github.com/jiangyi15/tf-pwa
4 changes: 2 additions & 2 deletions docs/api/static/zfit_physics.compwa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Import the module with:
import zfit_physics.compwa as zcompwa
This will enable that :py:function:~` tensorwaves.estimator.Estimator`, can be used as a loss function in zfit minimizers as
This will enable that :py:function:`~ tensorwaves.estimator.Estimator`, can be used as a loss function in zfit minimizers as

.. code-block:: python
Expand All @@ -21,7 +21,7 @@ More explicitly, the loss function can be created with
nll = zcompwa.loss.nll_from_estimator(estimator)
which optionally takes already created :py:class:~`zfit.core.interfaces.ZfitParameter` as arguments.
which optionally takes already created :py:class:`~zfit.core.interfaces.ZfitParameter` as arguments.

A whole ComPWA model can be converted to a zfit pdf with

Expand Down
2 changes: 1 addition & 1 deletion docs/api/static/zfit_physics.pyhf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The loss function can be created from a ``data`` and a ``pdf`` model with
which optionally takes already created :py:class:~`zfit.core.interfaces.ZfitParameter` as arguments.
which optionally takes already created :py:class:`~zfit.core.interfaces.ZfitParameter` as arguments.



Expand Down
4 changes: 2 additions & 2 deletions docs/api/static/zfit_physics.tfpwa.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Import the module with:
import zfit_physics.tfpwa as ztfpwa
This will enable that :py:function:~`tfpwa.model.FCN` can be used as a loss function in zfit minimizers as
This will enable that :py:function:`~tfpwa.model.FCN` can be used as a loss function in zfit minimizers as

.. code-block:: python
Expand All @@ -22,7 +22,7 @@ More explicitly, the loss function can be created with
nll = ztfpwa.loss.nll_from_fcn(fcn)
which optionally takes already created :py:class:~`zfit.core.interfaces.ZfitParameter` as arguments.
which optionally takes already created :py:class:`~zfit.core.interfaces.ZfitParameter` as arguments.


Variables
Expand Down
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ Extensions

api/static/zfit_physics.tfpwa.rst
api/static/zfit_physics.roofit.rst
api/static/zfit_physics.pyhf.rst
api/static/zfit_physics.compwa.rst

0 comments on commit 6a8ae3d

Please sign in to comment.