Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olibrian authored Jan 15, 2024
1 parent f7cdf4e commit e414c9f
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ Hier eine Sammlung von User Dokumentation/Dokumente von den Community Mitglieder
* Die Mitte: Wir zur Zeit noch erstellt (Mehrsprachig)

## Contribute generic user documentation (this repo)

This will be built with https://readthedocs.org/. The readthedocs page is rebuilt with each merged PR. At https://readthedocs.org/projects/hitobito/builds/ you can check whether the build was successful. If you are unsure, you can first merge into the beta branch. This is also built and can be reached at https://hitobito.readthedocs.io/de/beta/

A helpful overview over the restructured syntax that we use can be found here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
The [readthedocs](https://readthedocs.org/) page is rebuilt with each merged PR. You can check whether the build was successful [here](https://readthedocs.org/projects/hitobito/builds/). If you are unsure, you can first merge into the beta branch. This is also built and can be reached in the [beta page](https://hitobito.readthedocs.io/de/beta/)
A helpful overview over the restructured syntax that we use can be found [here](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)

Manual building:

Expand Down

0 comments on commit e414c9f

Please sign in to comment.