Hi Kim, >> project/ >> src/ >> module1/ >> docs/ >> module2/ >> docs/ >> docs/ >> >> Is this an unusual/not recommended layout?
I think it is not unusual, but if you want to make one overall document, you may need to use tricky method like symlink or else. I have divided the document directory in the units I want to publish. And I think it is easy to understand that one repository include one document tree. Regards, -- Takayuki SHIMIZUKAWA http://about.me/shimizukawa 2013/4/12 Kim Gräsman <[email protected]>: > Ping? > > I might add that the majority of our code is not Python, so devs primarily > want to put design documents near their code, not necessarily generate docs > from sources. > > Thanks, > - Kim > > > On Fri, Mar 15, 2013 at 10:46 AM, Kim Gräsman <[email protected]> wrote: >> >> Hello, >> >> We're about to start prototyping a Sphinx-based documentation system >> for our systems, and one of our wishes seems to go against the Sphinx >> spirit, so I wanted to ask here before we cement it too deeply. >> >> Say our codebase looks like this; >> >> project/ >> src/ >> module1/ >> module2/ >> >> It seems to me the expected place for Sphinx documentation should be >> under project/docs, set up by sphinx-quickstart, e.g. >> >> project/ >> src/ >> docs/ >> >> However, our developers have called for module-specific documentation >> as well as project-wide documentation, e.g. >> >> project/ >> src/ >> module1/ >> docs/ >> module2/ >> docs/ >> docs/ >> >> Is this an unusual/not recommended layout? >> >> We could support this with a simple prebuild step that copies all >> module docs directories into one shared root, and then does >> sphinx-build in there, but I'd rather keep it clean. >> >> Thoughts? -- 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?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
