On Tue, Mar 4, 2014 at 8:59 AM, Richard Dymond <[email protected]> wrote:
> My project has HTML documentation and man pages that I build with Sphinx.
> I'd like to place the source files for both the HTML docs and the man pages
> in the same source tree, but when I do that, I get warnings when I do 'make
> html' about the man page source files not being included in any toctree. Is
> there any way to suppress those warnings?
>
> I've tried adding the man page source filenames to exclude_patterns in
> conf.py, which does prevent the warnings, but also prevents the man pages
> from building. I don't want to place the man page source files in a toctree,
> because I don't want the man pages appearing in the HTML docs.
>
> I notice that Sphinx itself has the man page source files in the same source
> tree as the other source files, and 'make html' produces no warnings, even
> though the man page source files are not included in any toctree (as far as
> I can see). How does that work?

Put :orphan: at the top of the documents.

http://sphinx-doc.org/markup/misc.html

Skipper

-- 
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/groups/opt_out.

Reply via email to