Nessuna generazione dell'indice di modulo "modindex" quando si usa Sfinge

Question

Ho problemi a creare una directory di documenti (html) usando sphinx-build.

ho cercato

sphinx-build -b html source build 

così come

make html 

ma in entrambi i casi solo i file HTML search.html, index.html e genindex.html sono generati. Il file modindex.html è mancante.

Nel file conf.py ho impostato

html_domain_indices = True 

quindi dovrei avere un file modindex.html. Che cosa sto facendo di sbagliato? Non ricevo alcun messaggio di errore dopo aver creato i file html. Sto usando Sphinx 1.1.3 e Python 2.7 su Windows XP.

Answer 1

Breve versione

• corsa sphinx-apidoc -o . mymodule
• rimuovere il commento e modificare conf.py. Per questo esempio, sys.path.insert(0, os.path.abspath('mymodule'))
• re-run make html

Risposta lunga

posso riprodurre il problema con questo modulo di esempio:

$cat mymodule/mymodule.py 
def fn1(): 
    '''First function''' 
    pass 

def fn2(): 
    '''Second function''' 
    pass 

Esecuzione sphinx-quickstart produce il seguente albero:

$tree 
. 
├── Makefile 
├── _build 
├── _static 
├── _templates 
├── conf.py 
├── index.rst 
├── mymodule 
   └── mymodule.py 

$cat index.rst 
.. sphinx example documentation master file, created by 
    sphinx-quickstart on Mon Mar 30 15:28:37 2015. 
    You can adapt this file completely to your liking, but it should at least 
    contain the root `toctree` directive. 

con predefinito index.rst:

Welcome to sphinx example's documentation! 
========================================== 

Contents: 

.. toctree:: 
    :maxdepth: 2 



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

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

esecuzione make html a questo punto non produce alcun output in _build/html/py-modindex.html. Questo perché sphinx ha bisogno di file .rst che descrivano ogni modulo. Fortunatamente è facile da produrre usando sphinx-apidoc -o . mymodule. Questo dà due nuovi file, di cui solo il mymodule.rst è necessario per risolvere il problema di modindex nella domanda.

$head *mod*rst 
==> modules.rst <== 
mymodule 
======== 

.. toctree:: 
    :maxdepth: 4 

    mymodule 

==> mymodule.rst <== 
mymodule module 
=============== 

.. automodule:: mymodule 
    :members: 
    :undoc-members: 
    :show-inheritance: 

esecuzione make html a questo punto ancora non funziona. Ma decommentare e cambiare la riga che inizia con sys.path.insert in conf.py risolve le cose.

mio è: sys.path.insert(0, os.path.abspath('mymodule'))

PS: per evitare un ulteriore avviso, aggiungere modules alla Contents: toctree nel file index.rst.