Skip to content
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.

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

docs: Add ways to avoid building examples #1321

Merged
merged 3 commits into from
Feb 14, 2025
Merged

docs: Add ways to avoid building examples #1321

merged 3 commits into from
Feb 14, 2025

Conversation

auguste-probabl
Copy link
Contributor

@auguste-probabl auguste-probabl commented Feb 14, 2025

You can now run make html-noplot to build the docs without building the examples.

Closes #1247

  • Add Makefile target to avoid building examples
  • Add redundant option in sphinx/conf.py to guide contributors
  • Add documentation

You can now run `make html-noplot` to build the docs without building the examples.

Addresses #1247
Copy link
Contributor

github-actions bot commented Feb 14, 2025

Documentation preview @ a9c1ff6

Copy link
Collaborator

@thomass-dev thomass-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just a precision to add.

sphinx/conf.py Show resolved Hide resolved
@thomass-dev thomass-dev merged commit 64d7e88 into main Feb 14, 2025
7 checks passed
@thomass-dev thomass-dev deleted the select-examples branch February 14, 2025 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Shorten the duration of make html to focus only on your modified example
2 participants