CosmoStat/Tutorials

[Tutorial] Code Documentation with Sphinx

Opened this issue · 2 comments

What is the main topic of this tutorial: [Please provide one/two words, e.g. python, sparsity, etc.]
code documentation, sphinx

One line description
[Please describe here what you would hope to learn/teach]
I would like to learn more about creating and maintaining code documentation.

Level

  • Beginner
  • Intermediate
  • Advanced

Learning goals
[Please give here a few clear learning goals]

  • goal 1 Create code documentation
  • goal 2 Link to GitHub, man and other interfaces
  • goal 3 Maintain it
  • goal 4 Collaborate on it

I could do a learning slot on that.

This topic will be partially covered in #62