Skip to content

Doc: fixing cross-references #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raffienficiaud wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Doc: fixing cross-references #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0789cce
Doc: fixing cross-references
raffienficiaud Oct 27, 2025
57512f0
Typo fixes
raffienficiaud Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions docs/containers.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
---------------------------------------
Expand Down Expand Up @@ -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::
Expand All @@ -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.






1 change: 1 addition & 0 deletions docs/plugins.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/samplers.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


-------------------
Expand Down Expand Up @@ -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!
Expand All @@ -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`.
Loading