Skip to content

Initialize documentation page with Zensical#28

Merged
weiji14 merged 17 commits intomainfrom
docs
Feb 23, 2026
Merged

Initialize documentation page with Zensical#28
weiji14 merged 17 commits intomainfrom
docs

Conversation

@weiji14
Copy link
Member

@weiji14 weiji14 commented Feb 18, 2026

What I am changing

  • Add a nice static site to show our documentation!
  • Includes an example end-to-end workflow on the first page, and API docs

Preview at https://developmentseed.org/pixelverse/

Screenshot:

image

How I did it

  • Add zensical and some boilerplate files
  • Add mkdocstrings-python to render API docs nicely
  • Various other tiny edits to the docstrings and markdown files
  • Changed markdown linter from mdformat to rumdl to handle mkdocs-flavor markdown
  • Setup Continuous integration to deploy docs
  • Add favicon and more DevSeed theming
  • Trim down zensical.toml config

How you can test it

  • Run uv sync --all-groups && zensical serve

Related Issues

References:

A modern static site generator built by the creators of Material for MkDocs! Project at https://pypi.org/project/zensical/
Start with a minimally modified Zensical documentation site initialized with `zensical new .`. Updated the `zensical.toml` to have proper project metadata, and changed theme palette/icons slightly. Trimmed index.md and API Reference page to have minimal content for now.
A Python handler for mkdocstrings! Project at https://pypi.org/project/mkdocstrings-python/
Better support for mkdocs markdown flavour. Set line-length to 88 and allow HTML in README.md
Added API documentation for the download and embedding generation functions. Included some mkdocstrings-python config in zensical.toml to render things nicely. Main index page also has example end-to-end usage now. Also wrote some module-level docstrings and renamed get_s2_times_series to get_s2_time_series.
@weiji14 weiji14 self-assigned this Feb 18, 2026
@weiji14 weiji14 added the documentation Improvements or additions to documentation label Feb 18, 2026
Actually need to install the project, which would pull in lots of heavy dependencies. Let's go with uv then to be faster.
To avoid pulling in CUDA dependencies for pytorch.
Which contains manylinux_2_28_aarch64 wheels.
@martham93
Copy link
Contributor

Thanks for giving our docs a makeover this looks like its off to a great start! Excited to see more DevSeed themeing!

Adding DevSeed's favicon and socials, setting fonts to Roboto, etc.
@weiji14 weiji14 marked this pull request as ready for review February 19, 2026 01:53
@weiji14
Copy link
Member Author

weiji14 commented Feb 19, 2026

Not a CSS expert, so didn't go crazy on any DevSeed theming (just a favicon 😆). Let me know if you'd like any tweaks, especially the the API page (e.g. if you prefer a different layout).

@weiji14 weiji14 requested a review from martham93 February 19, 2026 01:55
@weiji14
Copy link
Member Author

weiji14 commented Feb 23, 2026

Gonna just merge this so we have things ready for the workshop in two days.

@weiji14 weiji14 merged commit 0c43cd8 into main Feb 23, 2026
2 checks passed
@weiji14 weiji14 deleted the docs branch February 23, 2026 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants