Index question

29 views
Skip to first unread message

Alejandro Marco Ramos

unread,
Oct 31, 2012, 1:30:34 AM10/31/12
to sphinx...@googlegroups.com
hi, this is my first contact with sphinx. My intention is make pdf documentation of various styles:

1. Articles/app-notes
2. Engineering projects formed with multiple text parts (in a engineering project, sections will be of differents authors)
3. Technical manuals

For the 1 type (app-notes/articles) the author is unique and don't need TOC, is mandatory the creation of the "index" file and "toctree" inside this?, how is the correct form of make this?.

Thanks in advance

Jonathan Waltman

unread,
Nov 1, 2012, 7:11:18 AM11/1/12
to sphinx...@googlegroups.com
On Wed, Oct 31, 2012 at 12:30 AM, Alejandro Marco Ramos
<alejandro....@gmail.com> wrote:
> hi, this is my first contact with sphinx. My intention is make pdf
> documentation of various styles:
>
> 1. Articles/app-notes
> 2. Engineering projects formed with multiple text parts (in a engineering
> project, sections will be of differents authors)
> 3. Technical manuals
>
> For the 1 type (app-notes/articles) the author is unique and don't need TOC,

You first have to specify the different pdf files you want to generate
using the configuration variable latex_documents [1]. This is also
where you can specify different authors for each document. The
"sectionauthor" directive [2] can be used to set the author for
individual sections.

> is mandatory the creation of the "index" file and "toctree" inside this?,

It is not necessary to have a toctree in the document. I don't think
an index will be generated if it is empty but I could be wrong.

[1] http://sphinx-doc.org/config.html?highlight=latex_documents#options-for-latex-output
[2] http://sphinx-doc.org/markup/misc.html?highlight=sectionauthor#directive-sectionauthor

--
Jonathan Waltman
Reply all
Reply to author
Forward
0 new messages