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.

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

[Tutorial] Code Documentation with Sphinx #58

Open
1 of 3 tasks
fadinammour opened this issue Jul 6, 2020 · 2 comments
Open
1 of 3 tasks

[Tutorial] Code Documentation with Sphinx #58

fadinammour opened this issue Jul 6, 2020 · 2 comments
Labels
tutorial request New tutorial request and discussion

Comments

@fadinammour
Copy link
Contributor

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
@fadinammour fadinammour added the tutorial request New tutorial request and discussion label Jul 6, 2020
@sfarrens
Copy link
Member

sfarrens commented Jul 6, 2020

I could do a learning slot on that.

@sfarrens
Copy link
Member

This topic will be partially covered in #62

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorial request New tutorial request and discussion
Projects
None yet
Development

No branches or pull requests

2 participants