HI Glenn,
On 31 August 2014 18:44, Glenn Waldron <[email protected]> wrote: > Here's another option to consider... > > For osgEarth we use ReadTheDocs. You store your documentation right in the > source repo alongside the code. That's nice - it keeps everything in one > place and lets you revision the documentation as you would anything else. > Docs are in RST format, making them human-readable as plain text as well. > > RTD integrates automatically with revision control systems. If I push a > change, the doc site updates automatically within minutes. (That's github, > not sure about other systems.) > > You can see our RTD-hosted docs site here: http://docs.osgearth.org > ReadTheDocs is at https://readthedocs.org/ > > Looks interesting. How much effort is it to set up and maintain? When users want to contribute I presume they need a github account and to be given permission to write? How to you manage this? I particular like the idea of the system being versioned, so also has the potential for keeping in sync with different releases, so if instance if a user wanted to use OSG-3.0 they could use just docs relevant to OSG-3.0. Robert.
_______________________________________________ osg-users mailing list [email protected] http://lists.openscenegraph.org/listinfo.cgi/osg-users-openscenegraph.org
