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.

Sign up for GitHub

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

Jump to bottom

Create template for documentation #77

Open
ChrsBaur opened this issue Dec 4, 2022 · 1 comment
Open

Create template for documentation #77

ChrsBaur opened this issue Dec 4, 2022 · 1 comment

Comments

@ChrsBaur
Copy link

ChrsBaur commented Dec 4, 2022

It's important to create the documentation at the same time as you code your project, otherwise you won't ever do it or you'll die trying.

To create a template for documentation, MkDocs or Sphinx could be a solution.

MkDocs
Sphinx
@klamann
Copy link
Contributor

klamann commented Dec 4, 2022

yeah, we're doing that already with personio-py. I'm not sure if it's worth the effort, since we have all relevant information in the Readme and the wiki. What do you think would be the benefits?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@klamann @ChrsBaur