Skip to content
Snippets Groups Projects

Update RTD documentation. (docstrings, changelog, documentation refactors)

Merged Karim Ahmed requested to merge doc/update_pycalibration_documentation into master
3 files
+ 99
88
Compare changes
  • Side-by-side
  • Inline
Files
3
+ 3
2
@@ -403,6 +403,9 @@ with open("available_notebooks.rst", "w") as f:
@@ -403,6 +403,9 @@ with open("available_notebooks.rst", "w") as f:
"""))
"""))
for detector in sorted(notebooks.notebooks.keys()):
for detector in sorted(notebooks.notebooks.keys()):
 
# Avoid having test notebooks in detector notebooks documentations.
 
if "TEST" in detector.upper():
 
continue
values = notebooks.notebooks[detector]
values = notebooks.notebooks[detector]
f.write("{}\n".format(detector))
f.write("{}\n".format(detector))
f.write("{}\n".format("-"*len(detector)))
f.write("{}\n".format("-"*len(detector)))
@@ -410,8 +413,6 @@ with open("available_notebooks.rst", "w") as f:
@@ -410,8 +413,6 @@ with open("available_notebooks.rst", "w") as f:
for caltype in sorted(values.keys()):
for caltype in sorted(values.keys()):
data = values[caltype]
data = values[caltype]
if data.get("notebook", None) is None:
continue
nbpath = os.path.abspath("{}/../../../{}".format(__file__, data["notebook"]))
nbpath = os.path.abspath("{}/../../../{}".format(__file__, data["notebook"]))
with open(nbpath, "r") as nf:
with open(nbpath, "r") as nf:
nb = nbformat.read(nf, as_version=4)
nb = nbformat.read(nf, as_version=4)
Loading