diff --git a/alea/model.py b/alea/model.py index 5be8e707..6296b3cd 100644 --- a/alea/model.py +++ b/alea/model.py @@ -260,7 +260,7 @@ def get_expectation_values(self, **parameter_values): def nominal_expectation_values(self): """Nominal expectation values for the sources of the likelihood. - For this to work, you must implement `get_expectation_values`. + For this to work, you must implement ``get_expectation_values``. """ return self.get_expectation_values() # no kwargs for nominal diff --git a/alea/models/blueice_extended_model.py b/alea/models/blueice_extended_model.py index 3eaefddb..b6f4b6c0 100644 --- a/alea/models/blueice_extended_model.py +++ b/alea/models/blueice_extended_model.py @@ -19,7 +19,7 @@ class BlueiceExtendedModel(StatisticalModel): """A statistical model based on blueice likelihoods. - This class extends the `StatisticalModel` class and provides methods + This class extends the ``StatisticalModel`` class and provides methods for generating data and computing likelihoods based on blueice. Attributes: @@ -127,7 +127,7 @@ def data(self, data: Union[dict, list]): def get_source_name_list(self, likelihood_name: str) -> list: """Return a list of source names for a given likelihood term. The order is the same as used - in the `source` column of the data, so this can be used to map the indices provided in the + in the ``source`` column of the data, so this can be used to map the indices provided in the data to a source name. Args: diff --git a/alea/parameters.py b/alea/parameters.py index 04b69972..9ba1424d 100644 --- a/alea/parameters.py +++ b/alea/parameters.py @@ -142,7 +142,7 @@ def nominal_value(self, value: Optional[float]) -> None: @property def needs_reinit(self) -> bool: - """Return True if the parameter needs re-initialization (for ptype `needs_reinit`).""" + """Return True if the parameter needs re-initialization (for ptype ``needs_reinit``).""" needs_reinit = False if self.ptype == "needs_reinit": needs_reinit = True diff --git a/docs/make_docs.sh b/docs/make_docs.sh index 64a7b523..c26687b8 100755 --- a/docs/make_docs.sh +++ b/docs/make_docs.sh @@ -2,4 +2,5 @@ make clean rm -r source/reference sphinx-apidoc -o source/reference ../alea +rm source/reference/modules.rst make html #SPHINXOPTS="-W --keep-going -n" diff --git a/docs/source/reference/modules.rst b/docs/source/reference/modules.rst deleted file mode 100644 index 544b6d78..00000000 --- a/docs/source/reference/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -alea -==== - -.. toctree:: - :maxdepth: 4 - - alea