Hi,

I'm starting to evaluate sphinx in the hope of escaping from docbook.

One apparently missing feature is the ability to pull in Javadoc
documentation: unfortunately I need to include such documentation in
the set of manuals I'm working on.

One key thing I need to be able to do is conditionally include. I'd
prefer to be able to do this both per-file and per-"chunk" within a
file, but could live with the former if necessary. Unfortunately I
can't yet see how to do this (but I'm still reading the sphinx docs).

All I've found so far is the "only" directive. (BTW The 1.0b
http://sphinx.pocoo.org/latest/markup/misc.html has a missing closing
parenthesis in the "Including content based on tags" section: should
be "draft)) are supported".)

The manual does not really explain how to use "only" nor do I
understand the example. Can I do this for example:

.. toctree::

   file1
   file2
.. only:: extra
   file3

   file4

so that file3 is only included if the extra tag is defined? And is the
blank line enough to end the only's scope?

The manuals I'm concerned with have "chunks" of 3 kinds: unflagged,
toolkit-flagged (e.g., qt3, qt4, java-awt, java-swt, etc.), language-
flagged (e.g., python, perl, tcl, etc.), or toolkit & language-
flagged.

I have to output different versions of the manuals. One version must
have everything, while all the other versions must have all the
unflagged content plus any flagged content that matches the specified
toolkit or language or both.

So I'd like to be able to do:

$ sphinx-build -b html

This should build everything.

$ sphinx-build -b html -t qt3 -t qt4 -t python -t javascript

This should build all unflagged content and any content that has any
of the flags qt3, qt4, python, or javascript & where the content has
both toolkit & language flags they must match (i.e., qt3 & python, qt3
& javascript, etc.).

I can't really see how to do this in sphinx. Is it possible?

Thanks!

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to