Compile docs for a single event

While this repository contains the documentation for all events, one might want to obtain a compiled version of the documentation for a single event only.

Here are the main steps:

• Add 'aiida-tutorials' to the intersphinx_mapping dictionary at the end of the conf.py file:

  intersphinx_mapping = {
      'aiida': ('http://aiida-core.readthedocs.org/en/latest/', None),
      'aiida-tutorials': ('https://aiida-tutorials.readthedocs.io/en/latest/', None),
  }

  This will make sure that, if you remove pages from your local version, the references (to links, objects) will point to the corresponding documentation that is online at the official link.

• Possibly, adapt the needed fields in the conf.py file (e.g. project, copyright, author (possibly leave it empty, if you prefer); the title also appears in a few other locations in the conf.py like latex_documents, texinfo_documents, ...

• Remove all pages that you don't need, and fix the main index.rst file to contain only what you need to say for your specific event.

• run make clean to remove the old compiled docs

• compile the documentation and check that there is no error (or fix them):

  • make html for the HTML version (compiled version in build/html, main file index.html)
  • make latexpdf for the PDF version (compiled version in build/latex/aiida-tutorials.pdf)

• Export the folders/files needed