A related issue: https://github.com/sphinx-doc/sphinx/issues/2717

On 2016-10-27 15:49:37 +0000, Warren Block said:

We would like to include a foreword before the table of contents page for a short introduction. Coming before the TOC, this presumably would
not be listed in the TOC.

Including text in the index file before the toctree directive seemed like a way to do this:

   Document Sample
   ===============

   Foreword
   --------

   Welcome to this document!

   .. toctree::
      :numbered:
      :maxdepth: 4

      intro
      ...


When rendered to PDF, the Foreword title appears as the first title of the TOC, and the "Welcome to this document!" text appears as the first text in the intro chapter.

Some searching found people asking how to accomplish this, but no clear answers. Can it be done?

The fall-back plan is to create a one-page PDF foreword and use a PDF merge utility like pdftk to combine that with the PDF created by sphinx. That's not elegant and introduces more dependencies. Is there a better way?



--
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.

Reply via email to