Skip to content

Commit 9d2d739

Browse files
committed
Fix URL formatting in the docs
1 parent fcc8c32 commit 9d2d739

5 files changed

Lines changed: 19 additions & 19 deletions

File tree

conda_package/docs/authors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ Contributors
2323
* Phillip J. Wolfram
2424
* Tong Zhang
2525

26-
For a list of all the contributions:
27-
https://github.com/MPAS-Dev/MPAS-Tools/graphs/contributors
26+
For a list of all contributions, see the
27+
`contributors graph <https://github.com/MPAS-Dev/MPAS-Tools/graphs/contributors>`_.

conda_package/docs/building_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ To preview the documentation locally, open the ``index.html`` file in the
2626
cd _build/html
2727
python -m http.server 8000
2828
29-
Then, open http://0.0.0.0:8000/master/ in your browser.
29+
Then, open `<http://0.0.0.0:8000/master/>`_ in your browser.

conda_package/docs/making_changes.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ things like whitespace at the end of lines.
2121
The first time you set up the ``mpas_tools_dev`` environment, you will need to set up
2222
``pre-commit``. This is done by running:
2323

24-
```bash
25-
pre-commit install
26-
```
24+
.. code-block:: bash
25+
26+
pre-commit install
2727
2828
You only need to do this once when you create the ``mpas_tools_dev``
2929
environment. If you create a new version of ``mpas_tools_dev``, then you will
@@ -43,9 +43,9 @@ PEP8 compliance, as well as sort, check and format imports,
4343
f-strings, and `mypy <https://mypy-lang.org/>` to check for consistent variable
4444
types. An example error might be:
4545

46-
```bash
47-
example.py:77:1: E302 expected 2 blank lines, found 1
48-
```
46+
.. code-block:: bash
47+
48+
example.py:77:1: E302 expected 2 blank lines, found 1
4949
5050
For this example, we would just add an additional blank line after line 77 and
5151
try the commit again to make sure we've resolved the issue.

conda_package/docs/releasing.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Version Bump and Dependency Updates
1717
- ``conda_package/mpas_tools/__init__.py``
1818
- ``conda_package/recipe/recipe.yaml``
1919

20-
- Make sure the version follows semantic versioning (see
21-
https://semver.org/).
20+
- Make sure the version follows
21+
`semantic versioning <https://semver.org/>`_.
2222
For release candidates, use versions like ``1.3.0rc1`` (no ``v`` prefix).
2323

2424
2. **Check and Update Dependencies**
@@ -38,7 +38,7 @@ Version Bump and Dependency Updates
3838
- The dependencies in ``recipe.yaml`` are the ones that will be used for the
3939
released package on conda-forge. The dependencies in ``pyproject.toml``
4040
are for PyPI and should be kept in sync as much as possible but are only
41-
there as a sanity check when we run ```pip check``. The ``dev-spec.txt``
41+
there as a sanity check when we run ``pip check``. The ``dev-spec.txt``
4242
file should include all dependencies needed for development and testing,
4343
and ``pixi.toml`` should remain equivalent for pixi users.
4444

@@ -100,8 +100,7 @@ Tagging and Publishing a Release Candidate
100100
- Update dependencies if needed
101101

102102
- Commit, push to a new branch, and open a PR **against the ``dev`` branch**
103-
of the feedstock:
104-
https://github.com/conda-forge/mpas_tools-feedstock
103+
of the `mpas_tools-feedstock <https://github.com/conda-forge/mpas_tools-feedstock>`_.
105104

106105
- Follow any instructions in the PR template and merge once approved
107106

@@ -112,7 +111,7 @@ Publishing a Stable Release
112111

113112
- For stable releases, create a GitHub release page as follows:
114113

115-
- Go to https://github.com/MPAS-Dev/MPAS-Tools/releases
114+
- Go to `the GitHub releases page <https://github.com/MPAS-Dev/MPAS-Tools/releases>`_
116115

117116
- Click "Draft a new release"
118117

@@ -127,8 +126,8 @@ Publishing a Stable Release
127126

128127
7. **Updating the conda-forge Feedstock for a Stable Release**
129128

130-
- Wait for the ``regro-cf-autotick-bot`` to open a PR at:
131-
https://github.com/conda-forge/mpas_tools-feedstock
129+
- Wait for the ``regro-cf-autotick-bot`` to open a PR at the
130+
`mpas_tools-feedstock repository <https://github.com/conda-forge/mpas_tools-feedstock>`_.
132131

133132
- This may take several hours to a day.
134133

@@ -137,7 +136,8 @@ Publishing a Stable Release
137136
- Merge once CI checks pass
138137

139138
**Note:** If you are impatient, you can accelerate this process by creating
140-
a bot issue at: https://github.com/conda-forge/mpas_tools-feedstock/issues
139+
a bot issue at the
140+
`mpas_tools-feedstock issues page <https://github.com/conda-forge/mpas_tools-feedstock/issues>`_
141141
with the subject ``@conda-forge-admin, please update version``. This
142142
will open a new PR with the version within a few minutes.
143143

conda_package/docs/visualization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ centers to triangle nodes. ``dsTris`` includes variables ``triCellIndices``,
4949
the cell that each triangle is part of; ``nodeCellIndices`` and
5050
``nodeCellWeights``, the indices and weights used to interpolate from MPAS cell
5151
centers to triangle nodes; Cartesian coordinates ``xNode``, ``yNode``, and
52-
``zNode``; and ``lonNode``` and ``latNode`` in radians. ``lonNode`` is
52+
``zNode``; and ``lonNode`` and ``latNode`` in radians. ``lonNode`` is
5353
guaranteed to be within 180 degrees of the cell center corresponding to
5454
``triCellIndices``. Nodes always have a counterclockwise winding.
5555

0 commit comments

Comments
 (0)