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

[docs] Update docs and wiki in prep for 1.15.0 #3282

Closed
johnkerl opened this issue Nov 2, 2024 · 1 comment
Closed

[docs] Update docs and wiki in prep for 1.15.0 #3282

johnkerl opened this issue Nov 2, 2024 · 1 comment
Assignees
Labels
blocker documentation Improvements or additions to documentation for-release-1.15

Comments

@johnkerl
Copy link
Member

johnkerl commented Nov 2, 2024

Found while working on issue #2407 / [sc-51048].

There, I need to do a docs audit for the new-shape feature.

I found that many things introduced recently -- including all new spatial classes -- are completely lacking from Python readthedocs content. (The R-side pkgdown material seems complete AFAICT.)

To do on this issue:

  • Add all new classes/methods/etc to the manually created .rst files
  • Add a new project-level wiki page regarding precisely what needs to be done manually as we all (on the team) do dev work and what is automated
  • Incorporate that into our established release procedure. Goal: ensure that all releases include docs for dev work in that release.
  • Also notice that 1.15.0rc3 isn't showing up at https://tiledbsoma.readthedocs.io/en/latest/ -- either we need to
    • modify our readthedocs logic to auto-build for RCs, or
    • within our release procedures, show how to manually trigger readthedocs for RCs
@johnkerl johnkerl closed this as completed Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocker documentation Improvements or additions to documentation for-release-1.15
Projects
None yet
Development

No branches or pull requests

1 participant