Add documentation page using DevSeed's mkdocs format (#19)

* Add devseed mkdocs basic template
* Add docs GitHub Actions CI workflow
* Add placeholder for tools & agents
* Add mkdocstrings to automatically create documentation from code
* Fix RUF022 `__all__` is not sorted
* Deploy to GitHub Pages from artifacts

Also move permissions from workflow-level to job-level.

---------

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
This commit is contained in:
Soumya Ranjan Mohanty
2025-12-05 20:16:45 +05:30
committed by GitHub
parent 9686d71da6
commit dddac818ea
11 changed files with 584 additions and 4 deletions
+8
View File
@@ -36,6 +36,14 @@ dev = [
"pre-commit",
"jupyterlab>=4.5.0",
]
docs = [
"mkdocs>=1.6.1",
"mkdocs-material[imaging]>=9.6.11",
"mkdocs-material-extensions>=1.3.1",
"pymdown-extensions>=10.14.3",
"mike>=2.1.3",
"mkdocstrings[python]>=1.0.0",
]
[build-system]
requires = ["hatchling"]