ifconfig and variables from conf.py

[Andrew]

Hi,

I was hoping to use the ifconfig to build slightly different versions
of my documentation (for different platforms).

I put the following code in my .rst file:

.. ifconfig:: livecd

Some Live CD specific text

and then added

livecd = True

to the conf.py. However, because (I think) of the line "if name in
self.values:" in "init_values" in "config.py", my 'custom' variable is
never loaded and so I get a warning when I build: "NameError: name
'livecd' is not defined" . I don't want to have to add "livecd" into
the "config_values" variable at the start of "config.py" as it's not a
general option - it's specific to this project.

Is there a reason that other variables can't be included in the
environment used by ifconfig? Is there a better way of achieving what
I'm trying to do (without maintaining two different sets of
documents)?

Thanks

Andrew

[Georg Brandl]

Andrew schrieb:

Yes -- new config values should be made known to Sphinx via the extension
API.

Put this into your conf.py:

def setup(app):
app.add_config_value('livecd', <the default: True or False>, True)

For more, see <http://sphinx.pocoo.org/ext/appapi.html>.

cheers,
Georg

[Andrew]

Thanks for getting back to me so quickly! I hadn't seen that part of
the documentation (or hadn't thought it would relate to this).

Thanks for your help (and an excellent tool!)

Regards

Andrew

[Kent Tenney]

might be good to add a mention of ``app.add_config_value`` on that page

>
> cheers,
> Georg
>
> >
>

[Georg Brandl]

Kent Tenney schrieb:

Indeed, added the reference and an example setup function.
The ifconfig docs were not updated from a different config API.

cheers,
Georg