Skip to content

Update docs generation for examples, add additional example - #1

Merged
Jekannadar merged 3 commits into
developfrom
feature/improve-examples-doc-generation
Mar 30, 2026
Merged

Update docs generation for examples, add additional example#1
Jekannadar merged 3 commits into
developfrom
feature/improve-examples-doc-generation

Conversation

@Jekannadar

Copy link
Copy Markdown
Contributor

The gen_example_pages.py script now separately handles Markdown, Source files, and images.
Examples are now expected to always be in a subfolder of examples in the root directory.

If there is a README.md present in a subfolder of examples:

  • The H1 heading of the file becomes the name of the example folder in the docs.
  • The README is named Overview in that doc folder.
  • All Python files are moved into a subfolder Source Files, which replicates the source tree structure.

@codecov

codecov Bot commented Mar 30, 2026

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@Jekannadar
Jekannadar merged commit 2f6731a into develop Mar 30, 2026
16 checks passed
@Jekannadar
Jekannadar deleted the feature/improve-examples-doc-generation branch April 14, 2026 10:21
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.

1 participant