Skip to content

Fix image handling for RTD builds #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pritkc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix image handling for RTD builds #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions doc/sphinx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,19 +147,18 @@ This process is handled by the `build.sh` script, which is called by the `doc-la

### Image Handling

Images are automatically handled when building the documentation using the Makefile targets:

The image handling process:
- Copies images from `doc/assets/img/` to `doc/sphinx/build/html/_static/img/`
- Fixes image paths in the HTML output
- For PDF output, converts SVG files to high-quality PDFs (using Inkscape)

If you're running Sphinx directly without the Makefile, you'll need to run the image copy script separately:

```bash
# Run after building documentation manually
./copy_images.sh
```
Images are automatically handled during the build process. The system automatically:

- **Collects images** from multiple locations:
- `doc/assets/img/` (main image directory)
- `source/math_functions/figures/` (math function figures)
- `source/api/examples/md/figures/` (example figures)
- Any `figures/` directory next to markdown files
- **Copies images** to `source/_images/` (standard Sphinx location)
- **Fixes image paths** in included markdown files automatically
- **For PDF output**: Converts SVG files to high-quality PDFs using Inkscape

**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.

## Development Workflow

Expand Down
Loading