Action #844

Feature #841: ctools tutorials and narrative introduction

Convert existing HTML documentation to rst.

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

Status:ClosedStart date:07/10/2014
Priority:HighDue date:
Assigned To:Deil Christoph% Done:

100%

Category:-
Target version:1.0.0
Duration:

Recurrence

No recurrence.

History

#1 Updated by Deil Christoph over 11 years ago

  • Assigned To set to Deil Christoph

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

  • Target version deleted (00-06-00)

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

  • Target version set to 00-07-00

#4 Updated by Knödlseder Jürgen almost 11 years ago

  • % Done changed from 0 to 10
I started the creation of the basic structure. Some of the initial html files are still there, and they should be replaced by rst files:
  • download.html
  • installation.html
  • quickstart.html

Also the reference documentation is still in the html/doc folder, also this should be replaced by appropriate rst files.

Finally, the Latex User Manual in the um folder should be converted into rst. The User Manual does not yet contain much information, but we should at least copy the current structure so that we can start filling-in information.

Christoph, didn’t you have a tool to convert Latex into rst?

#5 Updated by Deil Christoph almost 11 years ago

I used the pandoc tool (http://johnmacfarlane.net/pandoc/) and then cleaned up the output by hand.
There’s some info on the commands I used in #829.

Do you want me to do this?
Did you start in a branch or is all your work in devel?

#6 Updated by Knödlseder Jürgen almost 11 years ago

  • % Done changed from 10 to 50

I finally copied over the stuff by hand as there was not too much ...

#7 Updated by Knödlseder Jürgen almost 11 years ago

  • % Done changed from 50 to 80

Only things that is still missing is the reference documentation.

#8 Updated by Knödlseder Jürgen almost 11 years ago

  • Target version deleted (00-07-00)

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

  • Status changed from New to In Progress
  • Start date set to 07/10/2014

Is this done?

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

  • Target version set to 3rd coding sprint

#11 Updated by Deil Christoph over 10 years ago

Please merge this commit:
https://github.com/cdeil/ctools/compare/ctools:devel...no_tex

There’s still a few raw HTML files ... converting those to RST would make maintenance easier:
https://github.com/ctools/ctools/tree/devel/doc/source/fhelp
(we can make them just as nice as they look now)

#12 Updated by Deil Christoph over 10 years ago

  • Priority changed from Normal to Low

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

  • Priority changed from Low to High

We should make sure that this is done for the release version 1.0.0.

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

  • Target version changed from 3rd coding sprint to 1.0.0

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

  • Status changed from In Progress to Closed
  • % Done changed from 80 to 100
  • Remaining (hours) set to 0.0

All HTML documents have been converted into .rst.

Also available in: Atom PDF