On Mon, 28 Jan 2019 at 17:44, Matthew Woehlke <mwoehlke.fl...@gmail.com> wrote: > > On 25/01/2019 07.08, Peter Maydell wrote: > > 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 > > ? > > Do they need to cross-reference each other? > > If not, the easiest solution may be to just treat the two manuals as > entirely separate. That is, separate directories in the repo, separate > build steps, separate conf.py, etc... and then just don't write install > rules for the dev guide.
Thanks; yes, there's no strong need for the different manuals to cross-reference, so we can just treat them as separate. (I'm not sure how that would interact with third-party sites like readthedocs.io, but perhaps we could have a top level conf.py in docs/ which they would use, but which would be ignored by our makefile/install process which would just run sphinx-build separately on docs/devel/conf.py, docs/user/conf.py and so on. In any case having that kind of third-party site work is definitely only a secondary "nice to have" feature.) thanks -- 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.
