Hello,
On 14.02.19 04:39, Timothy Wrona wrote:
Okay so I dug a little deeper into this and it definitely looks like
sphinx is the correct tool to use, but I still have one problem.
I would like sphinx to be able to extract ".rst" formatted comments
directly out of my cmake source files to produce the documentation but I
can't seem to figure out how.
The standard modules that ship with cmake all have this ".rst" section
at the top that seems to magically get extracted and turned into online
documentation with sphinx, but I just can't figure out how they do it.
The standard modules have a shadow hierarchy at Help/module. For example
https://gitlab.kitware.com/cmake/cmake/blob/master/Help/module/GNUInstallDirs.rst
contains
.. cmake-module:: ../../Modules/GNUInstallDirs.cmake
There's no magic happening.
Thanks,
Gregor
--
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:
https://cmake.org/mailman/listinfo/cmake-developers
