search

UdK-VPT / BuildingSystems

Modelica BuildingSystems library
http://modelica-buildingsystems.de/
BSD 3-Clause "New" or "Revised" License
70 stars 34 forks source link

move documentation from special repo to docs directory #116

Closed thorade closed 6 years ago

thorade commented 6 years ago

This is work in progress, do not merge until it is done! Once it is done, please merge with "Squash & Merge".

The docs directory contains the source code in rst format that is used to build the tutorial. Unitl now, we have linked to a pdf version of the tutorial: http://modelica-buildingsystems.de/documentation.html https://github.com/UdK-VPT/BuildingSystems/blob/master/BuildingSystems/Resources/Documentation/UserGuide_BuildingSystems.pdf

In the future, we could use ReadTheDocs.org to build and serve the tutorial. RTD will build HTML, PDF and EPUB. Once configured correctly, the result would become visible e. g. here: http://buildingsystems.readthedocs.io/en/latest/ https://media.readthedocs.org/pdf/buildingsystems/latest/buildingsystems.pdf

The admin pages are here: https://readthedocs.org/projects/buildingsystems/ https://readthedocs.org/projects/buildingsystems/builds/

thorade commented 6 years ago

ToDo: