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

Scripts for generating interactive spec docs #630

Merged
merged 20 commits into from
Oct 10, 2024
Merged

Conversation

Tomaz-Vieira
Copy link
Contributor

@Tomaz-Vieira Tomaz-Vieira commented Sep 5, 2024

Adds scripts to generate flattened, interactive, html documentation.

image

Scripts will traverse the python typing hierarchy and produce nested tables with yaml examples at every level of the hierarchy. This gives us maximum flexibility both for rendering as well as for interacting with the documentaiton.

The logic can then be further expanded to add more metadata, like documentation for GUIs, that can be picked up by other external tools

@github-actions github-actions bot added ci Continuous Integration github_actions Pull requests that update Github_actions code labels Sep 5, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 10, 2024
Copy link
Member

@FynnBe FynnBe left a comment

Choose a reason for hiding this comment

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

Didn't go through the actual script, but as that is somewhat independent from the rest of the code base I'd say we can go ahead an merge this.
(We can change the readme linking these new docs afterwards as well)

README.md Outdated Show resolved Hide resolved
@FynnBe FynnBe merged commit 5a06d44 into main Oct 10, 2024
8 checks passed
@FynnBe FynnBe deleted the flattened_html_docs branch October 10, 2024 12:40
@FynnBe FynnBe mentioned this pull request Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration documentation Improvements or additions to documentation github_actions Pull requests that update Github_actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants