[cmake-developers] Properly Documenting a CMake Module
Timothy Wrona
tjwrona1992 at gmail.com
Wed Feb 13 08:57:00 EST 2019
Thanks for the info and the links! I will start looking into it. :)
On Wed, Feb 13, 2019 at 7:50 AM Torsten Robitzki <Torsten at robitzki.de>
wrote:
>
>
> > Am 13.02.2019 um 13:42 schrieb Brad King via cmake-developers <
> cmake-developers at cmake.org>:
> >
> > 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 request of some users so I haven't looked into how
> > that works, but one should be able to use sphinx to generate one's
> > own documentation and still cross-reference CMake’s online docs.
>
> I can confirm that this works as expected. Used it by myself.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://cmake.org/pipermail/cmake-developers/attachments/20190213/e9257bff/attachment-0001.html>
More information about the cmake-developers
mailing list