From 0789ccea6c022b663bcf444e1ea2c59a17389876 Mon Sep 17 00:00:00 2001 From: Raffi Enficiaud Date: Mon, 27 Oct 2025 16:23:25 +0100 Subject: [PATCH 1/2] Doc: fixing cross-references --- docs/plugins.txt | 1 + docs/samplers.txt | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/plugins.txt b/docs/plugins.txt index ec00ba726..83c0c7146 100644 --- a/docs/plugins.txt +++ b/docs/plugins.txt @@ -27,6 +27,7 @@ Currently :code:`bilby` allows for the following plugin groups: - :code:`"bilby.samplers"`: group for adding samplers to :code:`bilby`. See :ref:`Sampler plugins` for more details. +.. _sampler-plugins: --------------- Sampler plugins diff --git a/docs/samplers.txt b/docs/samplers.txt index 16c8df1eb..a168c9e6f 100644 --- a/docs/samplers.txt +++ b/docs/samplers.txt @@ -88,7 +88,7 @@ A list of available samplers can be produced using This will list native bilby samplers and any samplers available via a plugin. If a plugin provides a sampler that is also implemented in bilby, the bilby implementation will be labeled with the prefix `bilby.` to distinguish it from -the plugin version. See `sampler plugins`_ for more details. +the plugin version. See :ref:`sampler-plugins` for more details. ------------------- @@ -185,7 +185,7 @@ Adding new samplers to bilby We actively encourage the addition of new samplers to :code:`bilby`. We now recommended adding support for new samplers via the sampler plugins -interface. For more details, and a template, see `sampler plugins`_. +interface. For more details, and a template, see :ref:`sampler-plugins`. If you have a :code:`bilby` sampler plugin that you would like to be listed here, please let us know! @@ -212,4 +212,4 @@ will automatically be used instead of the native bilby interface. Some samplers may require additional installation steps. For more details about how sampler plugins, including a list of available -sampler plugins, see `sampler plugins`_. +sampler plugins, see :ref:`sampler-plugins`. From 57512f051ef694fb9383d025f67e144d30eac8d5 Mon Sep 17 00:00:00 2001 From: Raffi Enficiaud Date: Wed, 22 Apr 2026 08:24:56 +0200 Subject: [PATCH 2/2] Typo fixes --- docs/containers.txt | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/containers.txt b/docs/containers.txt index ae7e88218..4e4789087 100644 --- a/docs/containers.txt +++ b/docs/containers.txt @@ -4,7 +4,7 @@ Using Containers ================ -Containers package software together, providing all the neccersery dependencies +Containers package software together, providing all the necessary dependencies to run :code:`bilby`. Using containers can help eliminate installation/dependency issues, as well as ensure things are run in a standardized, reproducible environment. For a general introduction to @@ -24,7 +24,7 @@ getting started with singularity While Docker is better known throughout software development, singularity is often preferred in science applications as it focuses on reproducibility, makes interacting with your home file system easy, and is typically preferred -by cluster admins as it does not require root-priveledges as run time. +by cluster admins as it does not require root-privileges as run time. Running a bilby script with Singularity --------------------------------------- @@ -68,7 +68,7 @@ container run $ python --version Python 3.7.2 -The benefit of the container is that it has all the neccersery software +The benefit of the container is that it has all the necessary software is preinstalled, circumventing any dependency issues. .. note:: @@ -91,9 +91,3 @@ is preinstalled, circumventing any dependency issues. **Binding your local directory** - in the examples above, we gave the flag :code:`-B $PWD`. This can be neglected if you are working in your home directory. - - - - - -