Hi; for the QEMU project we're looking to convert our existing documentation to use Sphinx, and I have a question about how best to structure things, which I haven't been able to find an answer for in the documentation.
For QEMU we (will) have effectively several different manuals, but we don't want to ship them all to end users in "make install". To be concrete, we'll have, say, a "User documentation" manual which we do want to ship, but also a "Developer's guide" which deals with things that people working on QEMU internals want to know. We don't want to install the dev guide on every system, but it should be built in the source tree so that people using it can refer to it. What's the best way to structure the sphinx docs so that we can do something like: * building in the source tree builds all the docs (user and dev) * "make install" takes the subset of those docs that the user cares about and copies them into the install directory, and that subset doesn't have any cross references, links or index entries into documents that aren't installed ? The Sphinx documentation doesn't really seem to say anything about how to install generated HTML documentation, and mostly the examples assume you have exactly one lot of documentation and it's OK for it all to refer to each other and for the top level to have a toctree that links in everything. https://github.com/sphinx-doc/sphinx/issues/3132 has a comment from somebody saying they'd like to do something like what we want, but that issue isn't fixed yet -- is there a standard workaround? We haven't started the conversion yet, so we can be flexible about how to lay things out to work with whatever is best for Sphinx. Thanks in advance for any suggestions! -- PMM -- 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 sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
