Skip to content

Commit

Permalink
DOC: fix documentation links in README (#28)
Browse files Browse the repository at this point in the history
* DOC: fix documentation links in README

* Fix another link

* Re-enable CI test for links
  • Loading branch information
hagenw authored May 14, 2024
1 parent 16d0d53 commit 6f70866
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ jobs:
- name: Test building documentation
run: python -m sphinx docs/ docs/_build/ -b html -W

#- name: Check links in documentation
# run: python -m sphinx docs/ docs/_build/ -b linkcheck -W
- name: Check links in documentation
run: python -m sphinx docs/ docs/_build/ -b linkcheck -W
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Have a look at the installation_ instructions
and listen to examples_.


.. _datasets: https://audeering.github.io/usage.html#augment-a-database-to-disk
.. _examples: https://audeering.github.io/examples.html
.. _external: https://audeering.github.io/external.html
.. _files: https://audeering.github.io/usage.html#augment-files-in-memory
.. _installation: https://audeering.github.io/install.html
.. _signals: https://audeering.github.io/usage.html#augment-a-signal
.. _transforms: https://audeering.github.io/api/auglib.transform.html
.. _usage: https://audeering.github.io/usage.html
.. _user defined: https://audeering.github.io/api/auglib.transform.Function.html
.. _datasets: https://audeering.github.io/auglib/usage.html#augment-a-dataset-to-disk
.. _examples: https://audeering.github.io/auglib/examples.html
.. _external: https://audeering.github.io/auglib/external.html
.. _files: https://audeering.github.io/auglib/usage.html#augment-files-in-memory
.. _installation: https://audeering.github.io/auglib/install.html
.. _signals: https://audeering.github.io/auglib/usage.html#augment-a-signal
.. _transforms: https://audeering.github.io/auglib/api/auglib.transform.html
.. _usage: https://audeering.github.io/auglib/usage.html
.. _user defined: https://audeering.github.io/auglib/api/auglib.transform.Function.html


.. badges images and links:
Expand Down

0 comments on commit 6f70866

Please sign in to comment.