search

dh-tech / undate-python

A Python library for working with fuzzy, partial, or otherwise uncertain dates
Apache License 2.0
6 stars 1 forks source link

Set up docs #37

Closed ColeDCrawford closed 1 year ago

ColeDCrawford commented 1 year ago

Sphinx?

rlskoeser commented 1 year ago

Could also use mkdocs — seems like it might be a bit easier to get up and running? I'm more familiar with sphinx, but have used mkdocs a bit. I have examples of github actions workflows for building and publishing either of these.

Should be possible to set up a docs coverage check on PRs, too. I figured out a way to do that for sphinx, but looks like there's a coverage plugin for mkdocs as well.

rlskoeser commented 1 year ago

@all-contributors please add @maltevogl for documentation

allcontributors[bot] commented 1 year ago

@rlskoeser

I've put up a pull request to add @maltevogl! :tada:

rlskoeser commented 1 year ago

should we consider this task complete, and add a separate issue to setup readthedocs when we're ready?

maltevogl commented 1 year ago

We have now a readthedocs: https://undate-python.readthedocs.io and could add the button like this Documentation Status

rlskoeser commented 1 year ago

added badge & link to readme, considering this complete