openalea / openalea.rtfd.io

OpenAlea main documentation site

https://openalea.readthedocs.io/en/latest

5 stars 7 forks source link

Open pradal opened 2 years ago

pradal commented 2 years ago

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

pradal commented 2 years ago