Commit c8a98f7c authored by julian.gethmann's avatar julian.gethmann

Update link to documentation in README.rst

parent c8a07770
......@@ -4,9 +4,7 @@ Cassandra
Documentation
-------------
If you want to read the docu, you may find a PDF at `docs/_build/latex/cassandra.pdf` or a HTML documentation at
`docs/_build/html/index.html`. In doubt the HTML version is newer/more accurate.
In principle the docu should also be available as the `pages` artifact of the `GitLab-CI-Pipeline <https://git.scc.kit.edu/las-software/15-3-DataProcessing/cassandra/pipelines>`_.
You can download the documentation as HTML from the [Pipeline artifacts](https://git.scc.kit.edu/las-software/15-3-DataProcessing/cassandra/-/jobs/artifacts/master/browse?job=docs)
If you want or need to create the docu on your own you can find some general note about writing docu.
The docu is generated using `Sphinx <https://sphinx-doc.org>`_, is written in `ReStructuredText <https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>`_ and not in Markdown (like e. g. many other README files).
......
Markdown is supported
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