[cmake-developers] Converting CMake documentation to reStructuredText and Sphinx

[Brad King]

On 10/11/2013 11:34 AM, Alexander Neundorf wrote:
> On Thursday 10 October 2013, Brad King wrote:
>> The topic breaks some of the existing --help-* commands like --help-full,
> 
> Do you mean there won't be an all-in-one page anymore ?

There can be with a little more work beyond the current topic:

* The cmRST processor is capable of starting with Help/index.rst
  and printing out all manuals at once.  This will be useful only
  for human consumption because the output format is only meant
  to be human-readable text and does not conform to any markup.

* Sphinx supports a "singlehtml" builder that can generate all
  the manual pages in one giant html file.

> I find that one very useful (and use it also to add the documentation for 
> previous cmake releases in the cmake wiki ... still have to do this for 
> 2.8.12).

Huh?  Why/where are you doing this?

We already publish all version-specific documentation going
back pretty far:

 http://www.cmake.org/cmake/help/documentation.html
 CMake: 2.8.11, 2.8.10,  2.8.9, 2.8.8, 2.8.7, 2.8.6, 2.8.5, 2.8.4, 2.8.3, 2.8.2, 2.8.1, 2.8.0,  2.6.x.
 CTest: 2.8.11, 2.8.10,  2.8.9, 2.8.8, 2.8.7, 2.8.6, 2.8.5, 2.8.4, 2.8.3, 2.8.2, 2.8.1, 2.8.0,  2.6.x.
 CPack: 2.8.11, 2.8.10,  2.8.9, 2.8.8, 2.8.7, 2.8.6, 2.8.5, 2.8.4, 2.8.3, 2.8.2, 2.8.1, 2.8.0,  2.6.x.

 http://www.cmake.org/cmake/help/v2.8.11/cmake.html
 http://www.cmake.org/cmake/help/v2.8.10/cmake.html
 http://www.cmake.org/cmake/help/v2.8.9/cmake.html
 http://www.cmake.org/cmake/help/v2.8.8/cmake.html
 ...

-Brad