images fix test again

Author: prathameshnium

.github/workflows/docs.yml

@@ -5,7 +5,6 @@ on:
     branches: ["main"]
   workflow_dispatch:
 
-# Force GitHub Actions to use Node.js 24 for all steps
 env:
   FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
 
@@ -37,21 +36,22 @@ jobs:
           
       - name: Build HTML documentation
         run: |
-          # Build the documentation into the standard output folder
+          # 1. Build the documentation
           sphinx-build -b html docs/ docs/_build/html
 
-      - name: Fix Image Paths and Assets
+      - name: Mirror Structure for Images
         run: |
-          # 1. Create the expected directory structure in the output
-          # Since your MD uses "../pica/assets", we create a 'pica' folder 
-          # at the same level as your HTML files.
+          # This step makes "../pica/assets" work without changing your manual.
+          # We create a folder structure inside the build output that matches 
+          # your relative paths.
+          
           mkdir -p docs/_build/html/pica
           cp -r pica/assets docs/_build/html/pica/
-
-          # 2. Copy the publications folder as you did before
+          
+          # Copy publications folder
           cp -r publications/ docs/_build/html/publications/ || true
-
-          # 3. CRITICAL: Add .nojekyll to ensure GitHub Pages serves underscore folders
+          
+          # CRITICAL: Prevent GitHub from hiding folders starting with underscores
           touch docs/_build/html/.nojekyll
           
       - name: Upload GitHub Pages artifact

docs/conf.py

@@ -1,24 +1,37 @@
-project = 'PICA (Python Instrument Control and Automation)'
-copyright = '2026, Prathamesh Deshmukh'
+# docs/conf.py
+
+# -- Project information -----------------------------------------------------
+project = 'PICA'
+copyright = '2025, Prathamesh Deshmukh'
 author = 'Prathamesh Deshmukh'
+release = '1.0.0'
 
-# Activate the MyST Parser to enable Markdown support alongside standard extensions
+# -- General configuration ---------------------------------------------------
 extensions = [
-    'myst_parser',
-    'sphinx.ext.autodoc',
+    'myst_parser',           # For Markdown support
+    'sphinx_rtd_theme',      # For the ReadTheDocs theme
+]
+
+# Configure MyST-Parser to allow HTML images (the <img src="..."> tags in your manual)
+myst_enable_extensions = [
+    "html_image",
 ]
 
-# Instruct Sphinx to read both Markdown and reStructuredText formats
+# Map file extensions to the parser
 source_suffix = {
     '.rst': 'restructuredtext',
     '.md': 'markdown',
 }
 
-# Utilize the standard Read the Docs visual theme
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
 html_theme = 'sphinx_rtd_theme'
 
-myst_enable_extensions = [
-    "html_image",       # Allows raw HTML <img> tags to render
-    "html_admonition",  # Allows raw HTML blocks
-    "colon_fence",      # Enables ::: fenced directives
-]
+# Add any paths that contain custom static files (such as style sheets)
+html_static_path = ['_static']
+
+# This ensures Sphinx doesn't complain about the pica folder 
+# we manually move in the workflow
+suppress_warnings = ['image.not_readable']