NeuroML/Documentation

Feature Request: PDF Download & Page Number

irahulsonkar opened this issue · 8 comments

  1. It would be nice to have a full pdf download option for the documentation . Current download button only gives pdf of the active section/chapter.
  2. Alternatively, if the user tries to build the pdf locally from the repository then there are no page numbers in the generated pdf. It will be helpful if page numbers can be included in future version for pdf.

Thanks for the issue @irahulsonkar . We use jupyter-book to generate the website, so whatever is missing is missing from there. I see an issue here already:

executablebooks/jupyter-book#1106

where this page is linked to:

https://jupyterbook.org/en/stable/advanced/pdf.html

Is this what you tried? Did you use the LaTeX way to generate the pdf or was it from the HTML? (Either way, another issue to be reported to the upstream repository if it hasn't already been reported).

Thanks for your reply @sanjayankur31.
Yes. I followed the same link and used pdfhtml build.

OK, I'll try and replicate it, and if i can it's a bug that we should file upstream.

You can now download the full PDF (generated with LaTeX) here:

https://docs.neuroml.org/_static/neuroml-documentation.pdf

Also added a section to the docs here:

https://docs.neuroml.org/Userdocs/Usage.html#downloading-this-documentation-as-pdf

Let me know if you find any more issues with any of this too, please. Thanks.

Thanks! It looks really nice.

@sanjayankur31 , your documentation is fantastic. If you don't mind me asking: how in the world did you get the page numbers to show up in the exported PDF? I've looked through all your code and can't figure it out.

Hi @mrileysamc , thanks! I don't remember doing anything extra tbh---the jupyter-book pdflatex builder seems to do it automatically as part of the build. These are the only latex related builds in the config:

# Define the name of the latex output file for PDF builds

latex_elements: # https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/276#issuecomment-1102154800

the latter is only a workaround to get citations working in captions from what I remember.

@sanjayankur31 Thanks for the quick response! I think my problem is I'm using pdfhtml instead of pdflatex. Updating my latex package now and going to try again.