Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up docs #37

Closed
ColeDCrawford opened this issue Nov 10, 2022 · 6 comments
Closed

Set up docs #37

ColeDCrawford opened this issue Nov 10, 2022 · 6 comments
Assignees

Comments

@ColeDCrawford
Copy link
Collaborator

Sphinx?

@rlskoeser
Copy link
Member

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.

maltevogl added a commit to maltevogl/hackathon-2022 that referenced this issue Nov 11, 2022
ColeDCrawford added a commit that referenced this issue Nov 14, 2022
Addresses #28, #37 moved main files to src folder. Testing and sphinx…
@rlskoeser
Copy link
Member

@all-contributors
please add @maltevogl for documentation

@allcontributors
Copy link
Contributor

@rlskoeser

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

@rlskoeser
Copy link
Member

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

@maltevogl
Copy link
Member

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

@rlskoeser
Copy link
Member

added badge & link to readme, considering this complete

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants