On 04/24/2014 03:01 PM, Matthew Woehlke wrote:
> If there isn't currently a .rst file somewhere to concatenate all the 
> various documentation together with appropriate headings and table of 
> contents, this would probably be a good thing to add. (And then it could 
> be leveraged for --help-full.)

Help/index.rst is exactly this.  It's what generates the top-level
help page for html.  Our cmRST class we use to process .rst files
for the --help options is capable of starting there and traversing
the entire toctree.  Also the Sphinx 'singlehtml' builder can be
used to produce all documents in a single html file.

I had a work-in-progress topic left from back when I did the
documentation conversion to restore --help-full with index.rst
and add the Sphinx singlehtml option, but forgot about it.
I'm reviving it now.

-Brad

-- 

Powered by www.kitware.com

Please keep messages on-topic and check the CMake FAQ at: 
http://www.cmake.org/Wiki/CMake_FAQ

Kitware offers various services to support the CMake community. For more 
information on each offering, please visit:

CMake Support: http://cmake.org/cmake/help/support.html
CMake Consulting: http://cmake.org/cmake/help/consulting.html
CMake Training Courses: http://cmake.org/cmake/help/training.html

Visit other Kitware open-source projects at 
http://www.kitware.com/opensource/opensource.html

Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers

Reply via email to