FIX + Doc / Build_readthedocs_documentation

Fixing readthedocs build for pycalibration documentation:

https://rtd.xfel.eu/projects/european-xfel-offline-calibration/builds/

https://rtd.xfel.eu/docs/european-xfel-offline-calibration/en/latest/

Description

This has only some small fixes for the readthedocs to go forward and build successfully.

All the documentation needs to be revised.

How Has This Been Tested?

Relevant Documents (optional)

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• Docs (changes to the documentation)

Checklist:

Reviewers

@roscar @danilevc @schmidtp

docs/source/conf.py

@@ -13,6 +13,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import glob
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -20,6 +22,23 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+import os
+import shutil
+import sys
+import textwrap
+from datetime import datetime
+from subprocess import Popen, check_output
+from textwrap import dedent, indent
+from uuid import uuid4
+
+import nbformat
+import tabulate
+from dateutil.parser import parse
+from lxml import etree
+from nbconvert import RSTExporter
+
+# generate the list of available notebooks
+from xfel_calibrate import notebooks
 
 # -- General configuration ------------------------------------------------
 
@@ -39,11 +58,6 @@ extensions = [
     'sphinx.ext.viewcode',
 ]
 
-import glob
-import os
-import sys
-from subprocess import Popen
-
 sys.path.append(os.path.abspath("../pycalibration/"))
 p = Popen(["./makeAllDocs.sh"])
 p.communicate()
@@ -374,18 +388,7 @@ except:
     check_call(["wget", pandoc_url])
     check_call(["dpkg", "-i", pandoc_pack])
 
-import os
-from subprocess import check_output
-from textwrap import dedent, indent
-
-import nbformat
-from nbconvert import RSTExporter
-
-# generate the list of available notebooks
-from xfel_calibrate import notebooks
-
 rst_exporter = RSTExporter()
-
 with open("available_notebooks.rst", "w") as f:
     f.write(dedent("""
             .. _available_notebooks:
@@ -407,7 +410,8 @@ with open("available_notebooks.rst", "w") as f:
 
         for caltype in sorted(values.keys()):
             data = values[caltype]
-
+            if data.get("notebook", None) is None:
+                continue
             nbpath = os.path.abspath("{}/../../../{}".format(__file__, data["notebook"]))
             with open(nbpath, "r") as nf:
                 nb = nbformat.read(nf, as_version=4)
@@ -440,16 +444,7 @@ with open("available_notebooks.rst", "w") as f:
             f.write("\n\n")
 
 # add test results
-test_artefact_dir = os.path.realpath("../../tests/artefacts")
-
-import shutil
-import textwrap
-from datetime import datetime
-from uuid import uuid4
-
-import tabulate
-from dateutil.parser import parse
-from lxml import etree
+test_artefact_dir = os.path.realpath("../../tests/legacy/artefacts")
 
 
 def xml_to_rst_report(xml, git_tag, reports=[]):
@@ -575,7 +570,6 @@ Contents:
 """
 if not os.path.exists("./test_rsts"):
     os.makedirs("./test_rsts")
-
 with open("test_results.rst", "w") as f:
     f.write(header)
     for commit, modtime in sorted_dir(test_artefact_dir):
@@ -610,5 +604,6 @@ with open("test_results.rst", "w") as f:
                     fr.write(rst)
             f.write("   test_rsts/{}\n".format(commit))
 
+
 def setup(app):
     app.add_stylesheet('css/test_decorators.css')