Action #840

Feature #829: GammaLib tutorials and narrative introduction

Convert User Manual to rst.

Added by Knödlseder Jürgen about 11 years ago. Updated over 10 years ago.

Status:ClosedStart date:04/10/2013
Priority:HighDue date:
Assigned To:Deil Christoph% Done:

100%

Category:-Estimated time:0.00 hour
Target version:00-08-00
Duration:

Description

The User Manual is one of the most useful documents for GammaLib users. It should be one of the first to be translated into rst.

Note that the UM is only in a very very early stage of writing. By converting it to rst I hope we can make it evolve more quickly and complete it rapidly.


Recurrence

No recurrence.

History

#1 Updated by Knödlseder Jürgen about 11 years ago

  • Description updated (diff)
  • Priority changed from Normal to High

#2 Updated by Deil Christoph about 11 years ago

  • Assigned To set to Deil Christoph

#3 Updated by Knödlseder Jürgen about 11 years ago

  • Status changed from New to In Progress

#4 Updated by Deil Christoph about 11 years ago

FYI: with this one I screwed up a bit, because I ran pandoc without replacing the \newcommand first.
So there might be a few “GammaLib” words simply missing from the text.
Probably still easier to read it through once (I did that, but quickly) than to start the conversion from scratch.

#5 Updated by Knödlseder Jürgen about 11 years ago

Right, I left it “In Progress” for this reason. I guess we need to scan the .rst files to improve this.

I also see that the entire User Manual is a single flat file (here index.rst). I guess it would be nice if it were structured, so that pages are much shorter. What do you think?

#6 Updated by Deil Christoph about 11 years ago

Yes. Definitely break up into smaller chunks.
Same with the coding conventions.

It might be better to work out a structure for the documentation first and then refactor existing parts into that.
I think e.g. astropy has a good webpage and well-structured documentation and could serve as an example:

http://www.astropy.org
http://docs.astropy.org

I’m happy to contribute after the HESS collaboration meeting next week.
I’m not familiar enough with the Gammalib codebase to make good contributions, but e.g. rewriting existing examples into tutorials is something I can do.

#7 Updated by Deil Christoph about 11 years ago

Some more examples of documentation I like:

http://scikit-image.org/
http://scikit-learn.org/
http://pandas.pydata.org/pandas-docs/stable/

We should also find a way to link to Doxygen API docs from Sphinx.
This is not quite what we want I think, but might be worth a look:
http://michaeljones.github.io/breathe/

#8 Updated by Knödlseder Jürgen over 10 years ago

  • % Done changed from 0 to 20

Added some documentation

#9 Updated by Knödlseder Jürgen over 10 years ago

  • Status changed from In Progress to Closed
  • Remaining (hours) set to 0.0

#10 Updated by Knödlseder Jürgen over 10 years ago

  • % Done changed from 20 to 100
  • Estimated time set to 0.00

Also available in: Atom PDF