Menu
After checking out the CMake sources, I configured and build CMake successfully. But how do I build CMake's documentation? I have Sphinx installed.
There is no target like make doc and it is not obvious where I have to call which Sphinx command. I didn't find any hint in the CMake Wiki or their mailinglist archives.
589
To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.
Google Drive, Dropbox, Zapier, Google Chrome, and DevDocs are some of the popular tools that integrate with Sphinx. Here's a list of all 5 tools that integrate with Sphinx.
Yes, all of your API documentation is pulled from the C# XML docstrings that you have been writing. We use a few additional (optional) tags to allow you to organise your documentation a bit better, so that you can contextually place API documentation within various sections of your overall documentation.
Recently I found the answer [1]
Configure CMake with
-DSPHINX_HTML=ON. Be sure you have python-sphinx installed. PointSPHINX_EXECUTABLEat thesphinx-buildcommand if needed.
Run make. The documentation is built in directory Utilities/Sphinx/html.
[1] Written by the CMake developer Brad King at the CMake developer mailing list, https://cmake.org/pipermail/cmake-developers/2015-September/026567.html.
133
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
