Re: [sphinx-users] WARNING: document isn't included in any toctree

1,269 views
Skip to first unread message
Message has been deleted

Daniel Nephin

unread,
Dec 3, 2013, 9:02:31 PM12/3/13
to sphinx...@googlegroups.com
The error you're seeing is because you haven't included authentication under toctree. See http://sphinx-doc.org/concepts.html#dir-toctree

it should be:

.. toctree::
   :maxdepth: 2

   authentication


This will create your link to items in the authentication.rst document (instead of :doc:`Authentzaione`).

From the linked docs:

In the end, all documents in the source directory (or subdirectories) must occur in some toctree directive; Sphinx will emit a warning if it finds a file that is not included, because that means that this file will not be reachable through standard navigation. Use unused_docs to explicitly exclude documents from building, and exclude_trees to exclude whole directories.


On Tue, Dec 3, 2013 at 10:06 AM, Mirko Lazzarini <mlazzar...@gmail.com> wrote:
I don't understand what is my error, i haven't modindex.html and genindex.html is empty.

This is my index.rst

Welcome to iGate's documentation!
=================================

.. toctree::
   :maxdepth: 2

Struttura iGate
---------------

* :doc:`Autenticazione <authentication>`

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

And this is my authentication.rst

Autenticazione
==============

Login
-----

Per accedere all'applicazione iGate aprire il proprio browser e collegarsi all'indirizzo: http://igate.gm.porto.laspezia.priv

All'apertura della pagina compare la maschera di autenticazione. 

Inserire le proprie credenziali ricevute dal personale Infoporto e cliccare il pulsante **Login** per accedere all'applicazione.

.. image:: images/login.png

--
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...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.

Message has been deleted
Message has been deleted

Mirko Lazzarini

unread,
Dec 4, 2013, 5:42:34 AM12/4/13
to sphinx...@googlegroups.com
Ok now my index.rst is this:

Welcome to iGate's documentation!
=================================

Struttura iGate
---------------
.. toctree::
   :maxdepth: 2

   authentication
   menubar
   administration

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

But genindex si empty and modindex is not created :-(

Could you modify your previous post there is my personal link http://igate.gm...... i can't show that link :-(
Reply all
Reply to author
Forward
0 new messages