#3371 closed defect (fixed)
Missing documentation files in the Windows nightly build
| Reported by: | Francesco Casella | Owned by: | Adrian Pop |
|---|---|---|---|
| Priority: | critical | Milestone: | 1.9.4 |
| Component: | *unknown* | Version: | trunk |
| Keywords: | Cc: | Martin Sjölund, Adeel Asghar |
Description
The share/doc directory in the Windows nightly build does not contain any .pdf file, and in particular I cannot find the User Guide and the System Guide. Other documentation is also missing. I guess something went wrong when the build system was migrated to Git.
Attachments (1)
Change History (17)
comment:1 by , 9 years ago
| Cc: | added |
|---|
comment:2 by , 9 years ago
follow-up: 5 comment:3 by , 9 years ago
We now have the latest users guide here:
https://openmodelica.org/doc/OpenModelicaUsersGuide/
https://openmodelica.org/doc/OpenModelicaUsersGuide/latest
I'll change the nightly build to take it from here and include it in the installer.
follow-up: 6 comment:4 by , 9 years ago
I guess you should include the html files rather than the pdf. I am adding a tar.xz of the html to the SPHINX hudson job.
follow-up: 7 comment:5 by , 9 years ago
Replying to adrpo:
We now have the latest users guide here:
https://openmodelica.org/doc/OpenModelicaUsersGuide/
https://openmodelica.org/doc/OpenModelicaUsersGuide/latest
Please note that the text has references to "Appendices" which do not show up. E.g.:
https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/omedit.html#simulating-a-model
under General Tab - Methods refers to Appendix C, which is not really defined in this format of the documentation. BTW, a hyperlink would be highly recommended in these cases.
Also, there might be cross-references to different Sections using numbers, which do not show up at the moment.
comment:6 by , 9 years ago
Replying to sjoelund.se:
I guess you should include the html files rather than the pdf. I am adding a tar.xz of the html to the SPHINX hudson job.
I would humbly suggest to include both and leave it to the user to pick the one that suits him best :)
comment:7 by , 9 years ago
Replying to casella:
under General Tab - Methods refers to Appendix C, which is not really defined in this format of the documentation. BTW, a hyperlink would be highly recommended in these cases.
Appendix C was not part of the old User's Guide either :)
comment:8 by , 9 years ago
Vitalij has written a self-contained document regarding this topic, which used to be included in the share/doc subtree. I guess that should be the reference, and it should probably turned into Sphynx as well.
comment:9 by , 9 years ago
I am on it. Easy to convert it, but the document is out of date as it is. I might as well add an option to read all simualtion settings to have them up-to-date in the documentation.
by , 9 years ago
| Attachment: | new-doc.svg added |
|---|
follow-up: 12 comment:10 by , 9 years ago
Coming in tomorrow's documentation, automatically generated simflags description in the documentation, as well as the section on integration methods:
comment:11 by , 9 years ago
comment:12 by , 9 years ago
Replying to sjoelund.se:
Coming in tomorrow's documentation, automatically generated simflags description in the documentation, as well as the section on integration methods:
Now that's what I call a good idea!
Can you manage to close all issues in #2913 as well?
comment:14 by , 9 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
It seems that this issue has been solved long ago.
As far as I know we're in the process of moving from doc to Sphinx and somehow the documentation should be build automatically. I'll talk with Martin about it and see if we can fix this.