-
Notifications
You must be signed in to change notification settings - Fork 23
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
Add pdf version of the documentation #82
Conversation
@rjleveque This has nothing to do with this pull request, but looking through error messages I noticed that I am missing a file |
@ketch: I just added it. |
Thanks. I agree that some parts should be omitted. For instance, the source of all the pyclaw examples, which occupies a huge amount of space. I couldn't find an easy, automatic way to do it. Of course, we could manually edit a copy now and then for release. |
Also, the whole "developers guide" section appears twice in the PDF, because the pyclaw documentation links to it in a TOC. It seems desirable to do so in the HTML, since it only produces a hyperlink. But in the PDF it actually duplicates the whole section. |
I was browsing through the sphinx documentation for something that would allow us to exclude files or directories based on the output type but could not find anything. |
I see a way to add additional material at http://sphinx-doc.org/config.html, but not an easy way to omit. |
I just noticed this PR, should we merge this? |
There have been other changes since this PR, in particular we decided to get rid of |
I am closing this for now since I'm about to delete the master branch in view of our new naming conventions, see #188. |
To create the pdf:
The last step seems needed to make the TOC properly.
Problems: