Hello, Am 16.02.2011 15:47, schrieb gilberto dos santos alves: > there are one parameter that sets true or false to show warning > messages. you could find in manual of sphinx in directory ./doc I assume you are referring to "unused_docs" (which is deprecated since 1.0), which _suppresses_ the warnings.
I am not looking for a way to simply suppress the warnings. My problem is that the files that is warned about still end up in the final documentation. However, when packaging our software, not all components will be part of the final package. Therefore, I only want to include documentation for those components that are actually packaged. However, sphinx includes all documentation it can find in any subdirectory. I only found a way to explicitly _exclude_ certain files. Is there any switch/option to tell sphinx which files it should _include_ (only)? Explicit exclusion via "exclude_patterns/trees/dirnames" would be very inconvenient as it would require exhaustive listing of all files/subtrees that are not part of the package. Unfortunately, I am not very familiar with Python and not at all with modifying/recompiling (?) Python eggs (like Sphinx). Otherwise, I'd probably have look at the code directly and try to supply a patch ( if desired). Johannes > > 2011/2/9 Johannes Stallkamp <johannes.stallk...@ini.ruhr-uni-bochum.de > <mailto:johannes.stallk...@ini.ruhr-uni-bochum.de>> > > Hello, > > I am new to Sphinx and I am wondering whether it is possible to only > include rst files that are actually referenced in the TOC. > IIUC, I can only explicitly _exclude_ files. However, our projects > contain a flexible number of subcomponents in one large directory > tree. > I create the master index file dynamically via CMake to include only > references to the docs of those components that are included. When > running sphinx, I get warnings that some documents are not indexed > (the > ones of the excluded components) but they are nevertheless included. > > Is there any way to tell Sphinx to only include explicitly listed > files? > > Kind regards > Johannes > > -- > Johannes Stallkamp > Lehrstuhl Theorie kognitiver Systeme > Institut für Neuroinformatik > Ruhr-Universität Bochum > 44780 Bochum, Germany > > office: NB 3 / 71 > tel: +49 234 32 25566 > fax: +49 234 32 14209 > email: johannes.stallk...@ini.ruhr-uni-bochum.de > <mailto:johannes.stallk...@ini.ruhr-uni-bochum.de> > URL: http://www.ini.ruhr-uni-bochum.de > <http://www.ini.ruhr-uni-bochum.de/> > > -- > You received this message because you are subscribed to the Google > Groups "sphinx-dev" group. > To post to this group, send email to sphinx-dev@googlegroups.com > <mailto:sphinx-dev@googlegroups.com>. > To unsubscribe from this group, send email to > sphinx-dev+unsubscr...@googlegroups.com > <mailto:sphinx-dev%2bunsubscr...@googlegroups.com>. > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. > > > > > -- > gilberto dos santos alves > > (11) 8646-5049 > são paulo - SP - Brasil > > -- > You received this message because you are subscribed to the Google > Groups "sphinx-dev" group. > To post to this group, send email to sphinx-dev@googlegroups.com. > To unsubscribe from this group, send email to > sphinx-dev+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. -- Johannes Stallkamp Lehrstuhl Theorie kognitiver Systeme Institut für Neuroinformatik Ruhr-Universität Bochum 44780 Bochum, Germany office: NB 3 / 71 tel: +49 234 32 25566 fax: +49 234 32 14209 email: johannes.stallk...@ini.ruhr-uni-bochum.de URL: http://www.ini.ruhr-uni-bochum.de -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
