Closed peanutfun closed 2 years ago
I think this is a great idea. I'll go ahead and work on it now.
@peanutfun sorry should have pinged you regarding #114. When you get a chance take a look at #114 and let me know if that addresses your concerns and/or if there's more that should be added.
Is your feature request related to a problem? Please describe. The Example Workflow page in the docs demonstrates very verbosely how different comment blocks are transformed into RST. However, the workflow falls short of showing how to get an actual documentation from the RST. I realize that this can all be looked up in the Sphinx documentation but I think it would be helpful for users that do not have a RST toctree already. Since CMake is mostly used for C/C++ and Sphinx is typically used to document Python code, chances are high that users don't have a working Sphinx setup in their build.
Describe the solution you'd like Extend the example workflow with instructions for creating a Sphinx build. I did it the following way:
sphinx-quickstart
. Follow the instructions.cminx
on the project and set the sub-directory as output directory.sphinx-build
in that directory.Since the "translation" from CMake comments to RST is demonstrated a lot in other parts of the docs, the example could also be shortened to improve the readability of the doc page.
Describe alternatives you've considered None.
Additional context None.