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

Add pdf version of the documentation #82

Closed
wants to merge 3 commits into from

Conversation

rjleveque
Copy link
Member

To create the pdf:

    cd $CLAW/doc/doc
    make latex
    cd _build/latex
    make
    # then type q when it starts throwing errors that need to be fixed
    pdflatex ClawpackDocs30Nov2014

The last step seems needed to make the TOC properly.

Problems:

  • Lots of math errors are thrown.
  • Various things should probably be omitted, e.g. gallery?

@ketch
Copy link
Member

ketch commented Dec 1, 2014

@rjleveque This has nothing to do with this pull request, but looking through error messages I noticed that I am missing a file doc/doc/git_links.inc. Does this exist locally on your machine? It is not in the repo.

@rjleveque
Copy link
Member Author

@ketch: I just added it.

@ketch
Copy link
Member

ketch commented Dec 1, 2014

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.

@ketch
Copy link
Member

ketch commented Dec 1, 2014

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.

@mandli
Copy link
Member

mandli commented Dec 1, 2014

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.

@rjleveque
Copy link
Member Author

I see a way to add additional material at http://sphinx-doc.org/config.html, but not an easy way to omit.

@mandli
Copy link
Member

mandli commented Apr 3, 2016

I just noticed this PR, should we merge this?

@rjleveque
Copy link
Member Author

There have been other changes since this PR, in particular we decided to get rid of git_resources.rst, so I'll clean this up before merging.

@mandli mandli modified the milestone: 5.4 Aug 30, 2016
@rjleveque
Copy link
Member Author

I am closing this for now since I'm about to delete the master branch in view of our new naming conventions, see #188.

@rjleveque rjleveque closed this Aug 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants