Add docs basic structure and ancillary files#79
Merged
valeriupredoi merged 5 commits intomainfrom Jul 11, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #79 +/- ##
=======================================
Coverage 71.93% 71.93%
=======================================
Files 11 11
Lines 2423 2423
Branches 364 364
=======================================
Hits 1743 1743
Misses 583 583
Partials 97 97 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
valeriupredoi
commented
Jul 11, 2025
|
|
||
|
|
||
|
|
||
| @enduml No newline at end of file |
Collaborator
Author
There was a problem hiding this comment.
this is copied from PyActiveStorage, so is software-view1.pu and svg below - we should integrate some of that workflow docs into here, can delete at will, attn: @bnlawrence
Collaborator
Author
|
Merging now to have the foundational structure for the docs - actual docs and deployment to RTD after v0.5.0 is released 🍻 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
First attempt at structuring and fleshing out a docs module - ancillary files in (including a simple logo 😀 ) and docs build is functional, but currently only a small intro is fleshed out.
Useful for #75
I will merge this since it contains nothing that is really reviewable (unless you don't want to use Sphinx in which case you lost me haha)
Before you get started
Checklist