That's what I was looking for! Thanks!!!
On Thu, Feb 14, 2019 at 9:04 AM wrote:
>
>
> > Am 14.02.2019 um 14:53 schrieb Timothy Wrona :
> >
> > How does Sphinx know to go parse that ".cmake" file? Does Sphinx
> recognize the „cmake-module" keyword in a special way and know what to do
> with it?
> Am 14.02.2019 um 14:53 schrieb Timothy Wrona :
>
> How does Sphinx know to go parse that ".cmake" file? Does Sphinx recognize
> the „cmake-module" keyword in a special way and know what to do with it?
it’s from a Sphinx module that you can find the in the CMake sources
Hi Gregor,
It looks like there's still a little bit of magic here. All those
"Help/.rst" files just have a single line in them that says:
.. cmake-module:: ../../Modules/.cmake
How does Sphinx know to go parse that ".cmake" file? Does Sphinx recognize
the "cmake-module" keyword in a special way
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
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
I am going to quote your response in an answer on my stack overflow
question so others may find this information too.
On Wed, Feb 13, 2019 at 8:57 AM Timothy Wrona wrote:
> Thanks for the info and the links! I will start looking into it. :)
>
> On Wed, Feb 13, 2019 at 7:50 AM Torsten Robitzki
Thanks for the info and the links! I will start looking into it. :)
On Wed, Feb 13, 2019 at 7:50 AM Torsten Robitzki
wrote:
>
>
> > Am 13.02.2019 um 13:42 schrieb Brad King via cmake-developers <
> cmake-developers@cmake.org>:
> >
> > The online docs, like those at
> Am 13.02.2019 um 13:42 schrieb Brad King via cmake-developers
> :
>
> The online docs, like those at https://cmake.org/cmake/help/v3.14
> do publish a `/objects.inv` to support intersphinx:
>
> http://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
>
> This was done on
On 2/12/19 6:37 PM, Timothy Wrona wrote:
> a way to document custom CMake modules so that they work with the
> "cmake --help-module " command
There is no way to do this. The only reason --help-module exists
at all is because prior to 3.0 the documentation was generated by
the CMake binary itself,
Note: I have additionally posted this question to stack overflow so if you
would like to answer there rather than email it may help a larger audience:
https://stackoverflow.com/questions/54660549/what-is-the-proper-way-to-document-a-cmake-module
On Tue, Feb 12, 2019 at 6:37 PM Timothy Wrona
A quick Google search (...actually many rather extensive Google searches)
have not been able to explain how to properly document a CMake module.
What I'm looking for is a way to document custom CMake modules so that they
work with the "cmake --help-module " command. Is there any
standard way of
11 matches
Mail list logo
