Skip to content

Commit 0951479

Browse files
authored
Merge branch 'main' into formal
2 parents bc4fa2c + 6929148 commit 0951479

File tree

3 files changed

+343
-37
lines changed

3 files changed

+343
-37
lines changed

doc/sphinx/README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -147,19 +147,18 @@ This process is handled by the `build.sh` script, which is called by the `doc-la
147147

148148
### Image Handling
149149

150-
Images are automatically handled when building the documentation using the Makefile targets:
151-
152-
The image handling process:
153-
- Copies images from `doc/assets/img/` to `doc/sphinx/build/html/_static/img/`
154-
- Fixes image paths in the HTML output
155-
- For PDF output, converts SVG files to high-quality PDFs (using Inkscape)
156-
157-
If you're running Sphinx directly without the Makefile, you'll need to run the image copy script separately:
158-
159-
```bash
160-
# Run after building documentation manually
161-
./copy_images.sh
162-
```
150+
Images are automatically handled during the build process. The system automatically:
151+
152+
- **Collects images** from multiple locations:
153+
- `doc/assets/img/` (main image directory)
154+
- `source/math_functions/figures/` (math function figures)
155+
- `source/api/examples/md/figures/` (example figures)
156+
- Any `figures/` directory next to markdown files
157+
- **Copies images** to `source/_images/` (standard Sphinx location)
158+
- **Fixes image paths** in included markdown files automatically
159+
- **For PDF output**: Converts SVG files to high-quality PDFs using Inkscape
160+
161+
**For contributors**: Simply place images in `doc/assets/img/` or a `figures/` directory next to your markdown file, and reference them using standard markdown syntax: `![Alt text](doc/assets/img/image.png)` or `![Alt text](figures/image.png)`. The build system handles everything else automatically.
163162

164163
## Development Workflow
165164

0 commit comments

Comments
 (0)