Skip to content

Conversation

@tkknight
Copy link
Contributor

Enabled the pdf creation on the Read The Docs (RTD) service.

Note that we cannot create a pdf locally as RTD does some magic to do this. We should not need to as the PDF is based upon the same source as the built html, which we can build locally to check.

Every time RTD creates a new version of the html it should also create a PDF one too.

This PR also covers:

  • Fixing indention on a Makefile for pdf creation (not used at this time) - could be removed
  • Purging all latex/man options in the conf.py

When his PR is merged if you view the documentation via https://scitools-iris.readthedocs.io/en/latest/, if you click on the current version at the bottom of the sidebar you will have an option to view the PDF for the active version.

# call latex again to get page numbers right...
(cd build/latex; pdflatex -interaction=scrollmode documentation.tex);
echo "make latex in $$i.."; \
(cd $$i; $(MAKE) $(MFLAGS) $(MYMAKEFLAGS) latex); done
Copy link
Member

@QuLogic QuLogic Jul 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The done on the loop is here; the rest shouldn't be indented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot. The "make pdf" has not been used in a very long time. As the Read The Docs service can now do this I will remove the "pdf" target.

@bjlittle bjlittle self-assigned this Aug 3, 2020
@bjlittle
Copy link
Member

bjlittle commented Aug 3, 2020

@tkknight Awesome, thanks 👍

@bjlittle bjlittle merged commit e1489ff into SciTools:master Aug 3, 2020
tkknight added a commit to tkknight/iris that referenced this pull request Aug 3, 2020
* master:
  Gallery code consistency (SciTools#3766)
  enabled pdf creation (SciTools#3765)
tkknight added a commit to tkknight/iris that referenced this pull request Aug 14, 2020
* master:
  remove duplicate whats new entries from the last release (SciTools#3773)
  whatsnew latest update (SciTools#3771)
  whatsnew overhaul (SciTools#3769)
  Gallery code consistency (SciTools#3766)
  enabled pdf creation (SciTools#3765)
tkknight added a commit to tkknight/iris that referenced this pull request Aug 15, 2020
* master:
  remove duplicate whats new entries from the last release (SciTools#3773)
  whatsnew latest update (SciTools#3771)
  whatsnew overhaul (SciTools#3769)
  Gallery code consistency (SciTools#3766)
  enabled pdf creation (SciTools#3765)
  pin matplotlib<3.3 (SciTools#3763)
  moved to oceanography section of gallery (SciTools#3761)
  unpin cftime (SciTools#3757)
  flake8 outstanding files (SciTools#3755)
  Numpy rounding fix (SciTools#3758)
@tkknight tkknight deleted the enable_pdf branch September 10, 2020 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants