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
Various changes related to documentation #8
Conversation
Generated files should not be in the repository
- remove the htm/ dir each time, to ensure no stray generated files from previous runs remain - pass -i option to convert.pl, so only a single index file is generated - pass -u option instead of -t to convert.pl so that unicode characters are used in the generated HTML
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, thanks for the help @fingolfin !
@vendramin is this (and the two other PRs) OK to merge? If so, can you please do so? I have a few more changes to fix bugs ready, but they build on this PR, so it'd be easier if this PR could be merged first. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All changes look good to me. I didn't try to build the manual locally though, but I see a little merit in trying. In the long run, perhaps the documentation could be switched to AutoDoc.
@vendramin are you happy to merge this? |
This reduced test failures from 20 to 4 |
On master, the manual cannot actually be compiled, at least
make_doc
runs into an error for me. This PR fixes this, and a bunch of related things; it also adjusts manual examples, fixing various typos in them. Thetst/manual.tst
file is adjusted accordingly. This gets the number of test failures down, the remaining ones are due to actual bugs in this package. I also noticed that the functionNicholsDatum
is used in some examples but is undocumented.