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.

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

Jump to bottom

docs: generate some flowcharts using the diagrams package #938

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

docs: generate some flowcharts using the diagrams package #938

wants to merge 6 commits into from

Conversation

danceratopz
Copy link
Member

🗒️ Description

Adds:

  • A new "extras" section to pyproject.tom for dependencies to generate diagrams.
  • A jupyter notebook that uses the diagrams package to generate some flowcharts.
  • The generated diagrams as png (previews available in PR)..

The diagrams package also offers svg output, but the included icons aren't displayed.

🔗 Related Issues

None

Diagrams

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.

@danceratopz danceratopz added scope:docs Scope: Documentation type:chore Type: Chore labels Nov 5, 2024
@danceratopz danceratopz marked this pull request as draft November 5, 2024 11:01
@danceratopz danceratopz marked this pull request as ready for review November 5, 2024 13:33
@danceratopz danceratopz marked this pull request as draft November 6, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spencer-tb spencer-tb Awaiting requested review from spencer-tb

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
scope:docs Scope: Documentation type:chore Type: Chore
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@danceratopz