-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
LaTeX-ify the manual #458
LaTeX-ify the manual #458
Conversation
- Not complete yet
- Add TOC entry for licenses, too
- Adds a link to the header on GitHub - Many (but not all) references to GLM headers updated
- Also add note about the broken GLM discussion link
- Remove superfluous note at beginning - Indent code properly - Tighten up comments - Some using declarations
- Oops
- Rearrange me!
- The one link was dead
- Still need to tighten up some language, though
- Squash me!
- Also use the \glmheader{} macro
- Also added info about the metaprogramming helpers I added months ago
And it has been arranged. Actually, it turns out it's already been for quite some time, but I clarified it a bit. You still have to enable And yes, building the manual, when enabled, is part of the default target, but it can also be built separately via the |
- Some distributions may not include all relevant LaTeX packages out of the box, but may provide an easy way to obtain them
- Replaced URL with the correct one
Argh, I gotta find another package to do quotes with; |
I discover than Doxygen support markdown since the version 1.8: https://www.stack.nl/~dimitri/doxygen/manual/markdown.html I am wondering whether this wouldn't be a must easier way to manage to documentation. We can also use markdown for the main page. It seems to me that this solution satisfies a lot of goal:
|
You mean Markdown for the website or the manual? |
- Jesus, I almost forgot about this PR
- So the text properly appears on the next line of the manual
- Omitted a "mat" somewhere
(When you give the OK to the contents, I'll build and commit a PDF.) |
I gave a try to PR, here is the PDF it generated: I see the potential, but there are still many bugs. Also, I had a bunch of issues with Python. In the end I didn't manage to build within Visual Studio but it worked using:
Also, I had 61 warnings:
|
Visual Studio log:
|
…-manual # Conflicts: # CMakeLists.txt # doc/glm.docx
This issue was fixed by converting the manual into markdown in master branch for GLM 0.9.9 release. Thanks for contributing, |
I still have the proofreading/editing/better verbiage, though. Do you want me to contribute that to your new markdown docs? |
I see the proofreading/edits are isolated commits. I think I can just edit the markdown from those, thanks! |
Sure, go ahead. I see you've added some entirely new content, so later on I'll proofread that too. |
Why did I bother?
.docx
Just a few things before I think it's ready to merge:
minted
should play in the build process (it does source highlighting, but it has some other dependencies; I need to see what these dependencies are)You should probably put a build of the manual on the official website, tooNot going to happen, as discussed below, and I'm in no position to argue otherwiseThoughts so far?