Do not attempt PDF

.gitignore

@@ -10,11 +10,12 @@ __pycache__/
 
 docs/source/mirar*.rst
 docs/source/autogen/
-docs/source/extra/flowcharts/
+docs/pdf/
 
 # Distribution / packaging
 bin/
 build/
+_build/
 develop-eggs/
 dist/
 eggs/

.readthedocs.yml

@@ -26,5 +26,4 @@ sphinx:
   fail_on_warning: false
 
 formats:
-  - pdf
   - epub

README.md

@@ -1,5 +1,5 @@
 
-![alt text](docs/source/extra/MIRAR_logo.png?raw=true)
+![alt text](docs/source/MIRAR_logo.png?raw=true)
 
 # Modular Image Reduction and Analysis Resource (MIRAR)
 

docs/source/conf.py

@@ -32,8 +32,6 @@
 
 templates_path = ["_templates"]
 
-html_extra_path = ["extra"]
-
 # -- Options for HTML output
 
 html_theme = "sphinx_rtd_theme"

docs/source/contributors.rst

@@ -9,6 +9,7 @@ Other people who contributed to the code include:
 * Sulekha Kishore
 * Saarah Hall
 * Benjamin Roulston
+* Jamie Soon
 
 We especially thank Saarah for her suggestion of the code name, and Ben for creating the logo.
 

mirar/utils/docs/auto_config_docs.py

@@ -11,17 +11,13 @@
 
 from mirar.pipelines import Pipeline, get_pipeline
 from mirar.utils.docs.pipeline_visualisation import (
-    docs_extra_dir,
-    docs_source_dir,
+    base_autogen_dir,
     get_save_path,
     iterate_flowify,
 )
 
 logger = logging.getLogger(__name__)
 
-base_autogen_dir = docs_source_dir / "autogen"
-base_autogen_dir.mkdir(parents=True, exist_ok=True)
-
 
 def get_rst_pipeline_path(pipeline: str) -> Path:
     """
@@ -140,7 +136,7 @@ def auto_rst_config(pipeline: str, config: str):
     if not image_path.exists():
         iterate_flowify(config=config, pipelines=[pipeline])
 
-    relative_image_path = image_path.relative_to(docs_extra_dir)
+    relative_image_path = image_path.relative_to(base_autogen_dir)
 
     with open(output_path, "w", encoding="utf8") as output_file:
         doc = RstCloth(output_file)
@@ -155,7 +151,7 @@ def auto_rst_config(pipeline: str, config: str):
             )
         )
         doc.newline()
-        doc.content(f".. image:: ../../{relative_image_path}")
+        doc.content(f".. image:: {relative_image_path}")
         doc.newline()
 
 

mirar/utils/docs/pipeline_visualisation.py

@@ -23,10 +23,10 @@
 
 docs_source_dir = doc_dir / "source"
 
-docs_extra_dir = docs_source_dir / "extra"
-docs_extra_dir.mkdir(exist_ok=True)
+base_autogen_dir = docs_source_dir / "autogen"
+base_autogen_dir.mkdir(parents=True, exist_ok=True)
 
-flowchart_dir = docs_extra_dir / "flowcharts"
+flowchart_dir = base_autogen_dir / "flowcharts"
 flowchart_dir.mkdir(exist_ok=True)
 
 

pyproject.toml

@@ -46,7 +46,7 @@ wintertoo = "^1.5.0"
 scipy = "^1.12.0"
 python-dotenv = "^1.0.1"
 pyarrow = ">=15.0.2,<17.0.0"
-torch = "=2.3.0"
+torch = "==2.2.2"
 winterrb = "^1.0.0"
 
 [tool.poetry.group.docs.dependencies]