Add docs

[gadomski]

What I am changing

• Add docs

How I did it

• mkdocs-material and mike
• I put the Python docs in the stubs file
• Since it's a small repo, I KISS-ed it to a single mkdocs build — I figure we can keep all the versions (CLI, Python, and Rust) the same, and if we want to break that we can break out the docs later?

How you can test it

• https://developmentseed.org/cql2-rs/ — I didn't mean to deploy to our core site (I thought I'd just go to https://developmentseed.github.io/cql-rs) but I guess that domain redirects? Kinda spooky 👻

Related Issues

• Closes Python documentation #31
• Closes Switch to --workspace in CI #35 as a drive-by, except for cargo fmt which doesn't support --workspace

[kylebarron]

• Since it's a small repo, I KISS-ed it to a single mkdocs build — I figure we can keep all the versions (CLI, Python, and Rust) the same, and if we want to break that we can break out the docs later?

I don't feel the need to have rust documentation in the mkdocs site. IMO any docs targeting rust users should live at docs.rs/cql2.

• developmentseed.org/cql2-rs — I didn't mean to deploy to our core site (I thought I'd just go to developmentseed.github.io/cql-rs) but I guess that domain redirects? Kinda spooky 👻

Yeah developmentseed.org is hosted on github pages I believe, so any repo's github pages automatically get served from developmentseed.org.

[kylebarron]

It's a personal nit to always have an end of line character on the last line. I set this in my editor settings and also have pre-commit setups that enforce this on my own projects: https://github.com/developmentseed/lonboard/blob/4af9e2de490e99092fffafae817078e30da94bc2/.pre-commit-config.yaml#L16

[kylebarron]

Do you expect to ever publish beta versions? I find myself pushing alpha/beta versions decently often, but don't want to publish those to the public docs website: https://github.com/developmentseed/lonboard/blob/4af9e2de490e99092fffafae817078e30da94bc2/.github/workflows/deploy-mkdocs.yml#L59-L63

[gadomski]

I don't anticipate that very often for this repo — my hope is that we bake it and it just gets used.