Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update the user guide #117

Open
thorade opened this issue Apr 9, 2018 · 4 comments
Open

update the user guide #117

thorade opened this issue Apr 9, 2018 · 4 comments
Assignees

Comments

@thorade
Copy link
Contributor

thorade commented Apr 9, 2018

The User Guide pdf is created from rst source files, using Sphinx.
In the past, these files were hosted in a dedicated private repository,
but PR #116 moved the source files to the docs directory of this repository.

Some instructions on how to get started with rst and Sphinx are given in the ReadMe.rst file here:
https://github.com/UdK-VPT/BuildingSystems/tree/master/docs

The next step is now to update the users guide and tutorial!

@thorade thorade assigned thorade and rschopfer and unassigned thorade Apr 10, 2018
thorade added a commit that referenced this issue Apr 12, 2018
with text from #117
@thorade
Copy link
Contributor Author

thorade commented Apr 12, 2018

Pull Requests should trigger a build, and broken builds should block the merging!
Is this possible with protected branches and status checks?
readthedocs/readthedocs.org#1340 (comment)

@thorade
Copy link
Contributor Author

thorade commented Apr 13, 2018

@thorade
Copy link
Contributor Author

thorade commented May 15, 2018

The binary pdf file was previously stored in the repository,
but commit 27e4a85 removed it from the repository.
A backup of the old documentation pdf is here: UserGuide_BuildingSystems.pdf

@thorade
Copy link
Contributor Author

thorade commented May 15, 2018

Note: vector graphics give better quality than pixel graphics (where applicable).
Use image.* and Sphinx will use image.png or image.svg or image.pdf depending on output format
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#images

  • Dymola allows export as svg, the svg file can then be edited and converted to pdf using Inkscape.
  • dymat+matplotlib allow export as pdf directly, for plotting results diagrams.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants