Am 03.06.2015 um 17:49 schrieb Kevin Clarke:
> We would like to produce two sets of html documentation.
> - description-docs which provide high level of information from the
> rest source files ( think
> description of the software functions and what it does)
> - detailed-docs which contains all contents of description-docs but
> provides extra more detailed information ( above + the actual command
> / GUI action to achieve the function of the software and examples of its
> results)
>
> Is it possible to set up sphinx so that it can generate both outputs
> from the .rst file.
You can use the ifconfig extension of Sphinx and setup a configuration
variable in conf.py. Eg.
def setup(app):
app.add_config_value('html_set', '', True)
Then you can tag your text like this.
.. ifconfig:: 'detailed' in html_set
This is the extra detailed information.
To compile the normal version you set html_set to "normal" in conf.py:
html_set = "normal"
If you want to compile the detailed version you set it to "detailed":
html_set = "detailed"
You can use two different conf.py and call sphinx-build with the option -c.
HTH
juh
--
Software-Dokumentation mit Sphinx
http://www.amazon.de/dp/1497448689/
Paperback: 224 Seiten
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
