On Saturday, 20 July 2013 12:21:31 UTC+5:30, Carl Cerecke wrote:
>
> Hi,
>
> I'm struggling with how to organise a large collection of documents in
> a way that is easily compatible with sphinx.
>
> I have 100+ books (no code, this is just writing), and I'm thinking of
> organising them like so:
>
> /theme1/book1/book1.txt
> /theme1/book1/introduction.txt
> /theme1/book1/chapter{1-n}.txt # one file per chapter
> /theme1/book2/book2.txt
> /theme1/book2/introduction.txt
> /theme1/book2/chapter{1-m}.txt
>
> /theme2/etc.
>
> There might be a dozen 'themes', with each theme having 5-40 books in,
> and each book directory having one primary document (bookN.txt) which
> includes (via ".. include::") the other book parts.
>
> As well as this, there are various parts of books that are common
> between 2 or more books. So would also have something like:
>
> /common/text1.txt
> /common/text2.txt
>
> which would be included in each relevant book.
>
> Also, I have some customisation:
>
> /src/custom_role1.py
> /src/custom_directive1.py
>
> So far, I have one book working well in plain docutils, using paver to
> drive it. I can say things like:
> $ paver html book1 draft
> and get the draft version of book1 in html
>
> But plain docutils doesn't scale well with multiple documents, and I'd
> like more of a 'website' rather than just plain html pages.
>
> I'm pretty sure sphinx is up to the job, but I'm not sure of the best
> way to configure both my documents and sphinx itself. I still want to
> be able to produce each book individually as pdf/epub/whatever, but
> have a unified website that includes all the books in HTML.
>
> Am I heading in the right direction?
>
> I'm currently getting warnings that documents aren't included in any
> toctree when those 'documents' (actually, parts of a book) *are*
> included (via .. include::) into a document that *is* included in a
> toctree.
>
> Cheers,
> Carl.
>
Hi Carl,
You will have to use "toctree" directive of sphinx to organise hierarchy of
books/chapters/sections.
--
Purnank
--
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.
