Skip to content

Commit

Permalink
(docs) fix broken links [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
danieljprice committed Jan 31, 2024
1 parent cd95feb commit 7c15728
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/developer-guide/stable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ How to use download and use stable code releases
================================================

The master branch of phantom develops rapidly, but if you want to only
:doc:`stable versions of phantom <releasenotes>`, the best way is to use
:doc:`stable versions of phantom <../releasenotes>`, the best way is to use
the \`stable’ code branch from the git repository. **Nobody has
permission** to push directly to the stable branch, it must be updated
via pull request, so it **cannot** be inadvertently broken
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/staging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Procedure is:

- set the version number in phantom/build/Makefile
- set the version number in phantom/docs/conf.py
- update the :doc:`release notes <releasenotes>`
- update the :doc:`release notes <../releasenotes>`
- use git to tag the code version for the release

::
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/disc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The above procedure prints a .discparams file (in the above example would be
called disc.discparams) that contains some of the parameters used to
initialise the disc setup.

For a circumbinary disc the equation of state is set to a vertically isothermal equation of state (ieos=3) where the radius is taken with respect to *the coordinate origin*. See :doc:`Equations of state available in Phantom <eos>`
For a circumbinary disc the equation of state is set to a vertically isothermal equation of state (ieos=3) where the radius is taken with respect to *the coordinate origin*. See :doc:`Equations of state available in Phantom </physics/eos>`

check the .in file and proceed to run phantom
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -181,7 +181,7 @@ which produces::
secondary mass : 1.00
mass ratio : 1.00

For a circumprimary disc the equation of state is set to ieos=6, such that the radius is taken with respect to the first sink particle in the simulation. See :doc:`Equations of state available in Phantom <eos>`
For a circumprimary disc the equation of state is set to ieos=6, such that the radius is taken with respect to the first sink particle in the simulation. See :doc:`Equations of state available in Phantom <physics/eos>`

The Farris et al. (2014) :doc:`equation of state <eos>` (ieos=14 for a binary or ieos=13 if there are more than two stars) is also useful for a flyby simulation if one does not want to have excessively cold material around the secondary

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/running-first-calculation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ For the Sedov example shown above, there’s even an exact solution included in

.. important::
If you have v2.x or earlier of splash,
type ssplash instead of splash to read :doc:`the phantom native binary format<dumpfile>`.
type ssplash instead of splash to read :doc:`the phantom native binary format</user-guide/dumpfile>`.

The .ev files, which are just ascii files containing global quantities as a function of time::

Expand Down
File renamed without changes.

0 comments on commit 7c15728

Please sign in to comment.