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

How to Document your package #20

Open
pradal opened this issue Dec 15, 2021 · 1 comment
Open

How to Document your package #20

pradal opened this issue Dec 15, 2021 · 1 comment

Comments

@pradal
Copy link
Contributor

pradal commented Dec 15, 2021

Rational

We need o generate User, Modeller and developer documentation

  • What are the recommended tools?
    • Sphinx / readthedocs?
    • Markdown?
    • Others?
  • What are the strategy for user, modellers and developpers documentation?
    • developpers: doc string and sphinx?
    • modellers : reproducible papers and notebooks?
    • Users: Mardown in README or rst?

Simple and standard as possible but also efficient and complete
@thomasarsouze thomasarsouze changed the title Howto Document your package How to Document your package Dec 15, 2021
@pradal
Copy link
Contributor Author

pradal commented Dec 15, 2021

One simple package is: https://pdoc3.github.io

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
1 participant
@pradal