Change request #1431

Documentation versions

Added by Deil Christoph about 9 years ago.

Status:NewStart date:02/24/2015
Priority:NormalDue date:
Assigned To:-% Done:

0%

Category:-
Target version:-
Duration:

Description

As announced on the mailing list, currently there is:

The release documentation can be found at:
- http://cta.irap.omp.eu/gammalib/ (for GammaLib)
- http://cta.irap.omp.eu/ctools/ (for ctools)

The developer documentation can be found at:
- http://cta.irap.omp.eu/gammalib-devel/
- http://cta.irap.omp.eu/ctools-devel/

Here’s some suggestions:
1) the version number should be clearly displayed on the page (not just implicitly via the url) so that users don’t get confused.
2) put the version number in the URL ... this way if in the future you want to support e.g. 1.0 and 2.0 you can have docs online for both.
3) add a Javascript box that shows the user which versions of the docs are available and makes it easy to switch.

Here’s a good example of docs done this way (most projects do it this way):
https://docs.djangoproject.com/en/1.7/

The first two suggestions are easy to do, the last one might be non-trivial to implement.
For Sphinx there’s probably a readily-available solution, but if we also want this on the Doxygen pages it’s probably a bit of work to figure out how to do it.


Recurrence

No recurrence.

Also available in: Atom PDF