WSL/SLF GitLab Repository

Commit d8754ce6 authored by Aschauer's avatar Aschauer
Browse files

fix: typos and broken links in documentation

parent 977093f4
......@@ -20,7 +20,7 @@ Issue Reports
If you experience bugs or general issues, please have a look
on the `issue tracker`_. If you do not see any relevant issue for your problem
there, please create a new issue report. If you are new and not a member of
WSL/SLF, you first have to `register <https://gitlabext.wsl.ch/users/sign_up>`
WSL/SLF, you first have to `register <https://gitlabext.wsl.ch/users/sign_up>`_
to the WLS GitLab to create an issue.
.. tip::
......@@ -211,10 +211,13 @@ used to release a new version for ``swe2hs``:
#. make sure all changes are listed in the changelog
#. Run the following command to check if the package gets builded correctly::
tox -e clean,build
tox -e clean,build
#. tag your commit with the version name. The version tag needs to be of the
format ``v.X.X.X``.
format ``v.X.X.X``::
git tag vX.X.X
#. push the tag to GitLab, if the tag has the correct format, the Gitlab CI will
automatically build the package and upload it to PyPI.
......
......@@ -89,7 +89,7 @@ and activated environment by running::
This will also install all dependencies which are necessary for the package to
work correctly.
Verify the installation by running the following commands in a python console::
Verify the installation by running the following commands in a Python console::
>>> import swe2hs as jopack
>>> print(jopack.__version__)
......
......@@ -298,6 +298,7 @@ python_version = ".".join(map(str, sys.version_info[0:2]))
intersphinx_mapping = {
"sphinx": ("https://www.sphinx-doc.org/en/master", None),
"python": ("https://docs.python.org/" + python_version, None),
"dask": ("https://docs.dask.org/en/stable", None),
"matplotlib": ("https://matplotlib.org", None),
"numpy": ("https://numpy.org/doc/stable", None),
"numba": ("https://numba.readthedocs.io/en/stable", None),
......
......@@ -2,8 +2,9 @@
Examples and Usage
==================
In the following you find notebooks which demonstrate how the SWE2HS model can
be used. Basic knowledge of :mod:`pandas` and :mod:`xarray` is expected for the examples.
In the following you find notebooks which demonstrate how the :mod:`swe2hs`
Pathon package can be used. Basic knowledge of :mod:`pandas`
and :mod:`xarray` is expected for the examples.
.. toctree::
:maxdepth: 1
......
......@@ -116,7 +116,7 @@ plt.show()
## Plotting layers for each year individually
Often it is useful to plot each hydrological year independently. This can be
done with the utility function {py:func}`~swe2hs.visualization.groupby_hydroyear`
from the {py:mod}`swe2hs.visulaization` module.
from the {py:mod}`swe2hs.visualization` module.
We additionally choose that the layers are colored corresponding to the layer
density.
......
......@@ -107,7 +107,6 @@ And plot the whole SWE map at the first of February:
```{code-cell}
swe.sel(time='2001-02-01').plot()
print('changed')
plt.show()
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment