Repository navigation
Client documentation site (RTD) - #26
Merged
Merged
Conversation
…copybutton, links)
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Documentation build overview
27 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #26 +/- ##
==========================================
+ Coverage 92.05% 92.15% +0.10%
==========================================
Files 18 18
Lines 1460 1466 +6
==========================================
+ Hits 1344 1351 +7
+ Misses 116 115 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Client documentation site for https://spatialdata-db.readthedocs.io (RTD project
spatialdata-db).Merge order: after #24 (RTD config; its commit is at the base of this branch) and after #25 (the docs describe the
catalog-latestdefault and the fixedCatalog(version=...)).What's in it:
sphinx_book_themewith the DB's identity — site colour tokens for dark and light (follows the OS), SpatialData-DB wordmark + logo/favicon, header icons to the DB site / GitHub / Lamin, DB-coloured code highlighting (light-mode tokens darkened to ≥4.5:1 contrast).TaskAdapter(notebooks pre-executed against the live DB, small stores, outputs committed; RTD doesn't execute), CLI & MCP agents.sddb.__all__, CLI reference generated by Typer, MCP tools table, catalog-columns table generated from the schema, changelog. Tests fail if an export, CLI command or MCP tool goes undocumented.CITATION.cff(software; DB paper forthcoming).docsjob (sphinx-build -W), gated incheck.SITE_URL(currently https://spatialdata-db-web.pages.dev, since spatialdata-db.com isn't wired yet).SpatialDataCohort.verifydocstring corrected; gene-index size in CLI help (~260 MB).tutorials/is folded into the guides and removed.