Skip to content

Add docs basic structure and ancillary files#79

Merged
valeriupredoi merged 5 commits intomainfrom
add_docs
Jul 11, 2025
Merged

Add docs basic structure and ancillary files#79
valeriupredoi merged 5 commits intomainfrom
add_docs

Conversation

@valeriupredoi
Copy link
Collaborator

@valeriupredoi valeriupredoi commented Jul 10, 2025

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

  • This pull request has a descriptive title and labels
  • This pull request has a minimal description (most was discussed in the issue, but a two-liner description is still desirable)
  • Unit tests have been added (if codecov test fails)
  • Any changed dependencies have been added or removed correctly (if need be)
  • If you are working on the documentation, please ensure the current build passes
  • All tests pass

@codecov
Copy link

codecov bot commented Jul 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.93%. Comparing base (fe0606f) to head (77ed42f).
Report is 6 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.




@enduml No newline at end of file
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

@valeriupredoi
Copy link
Collaborator Author

Merging now to have the foundational structure for the docs - actual docs and deployment to RTD after v0.5.0 is released 🍻

@valeriupredoi valeriupredoi merged commit e6345ea into main Jul 11, 2025
5 checks passed
@valeriupredoi valeriupredoi deleted the add_docs branch July 11, 2025 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant