On Wed, Sep 26, 2018 at 7:20 PM Noah Watkins <noahwatkins@xxxxxxxxx> wrote:
>
> On Tue, Sep 25, 2018 at 1:57 PM Erwan Velu <evelu@xxxxxxxxxx> wrote:
> >
> > If that is possible, I would be lovely to get fixed URLs to reach {some}
> > configuration items.
> >
> > This way, it would be possible to have links between a versionned GUI
> > and its associated versionned documentation.
>
> Erwan,
>
> I did a little investigating on this suggestion yesterday. It appears
> that we can (1) mark settings/configuration items in the documentation
> with a semantic name, and (2) use write a basic Sphinx plugin to
> generate a URL map of these items when the documentation is built. I
> can see it looking something like a JSON file, say
> `ceph-docs-map-v13.2.1.json` containing a section that maps a term to
> a URL. This strategy is convenient because it places very little
> burden on maintaining those permalinks correctly other than just
> tagging configuration settings. Would something like that work? I
> suppose there are other strategies too.
We do also have the documentation strings for configuration settings
in options.cc, and it would be great to get the docs generated from
them too -- this was the aspiration at the point the strings went into
options.cc, but so far nobody has reaped the large kudos reward which
is on offer for hooking it all up into the docs build ;-)
John
