Skip to content

[Tutorial] Code Documentation with Sphinx #58

Description

@fadinammour

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    tutorial requestNew tutorial request and discussion

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions