Luogo di fonti Sfinge per i miei appunti

Question

Come si può risolvere avvertimento della Sfinge in fondo?

Sto cercando di avere le mie note Python nelle Sfinge. Ho i miei appunti in file separati allo stesso livello di directory come index.rst .

Ottengo i seguenti avvisi dopo aver costruito HTML

l'avviso

/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree

in

Il messaggio completo quando si costruisce

sudo sphinx-build -b html ./ _build/html
Running Sphinx v0.6.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 1 added, 2 changed, 0 removed
reading sources... [100%] trig_functions
/home/heo/S_codes/databooklet.rst:1: (WARNING/2) malformed hyperlink target.
/home/heo/S_codes/index.rst:11: (ERROR/3) Error in "toctree" directive:
invalid option block.

.. toctree::
   :numbered:
   :glob:
   *
   databooklet.rst
   trig_functions.rst


/home/heo/S_codes/trig_functions.rst:11: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/heo/S_codes/databooklet.rst:: WARNING: document isn't included in any toctree
/home/heo/S_codes/trig_functions.rst:: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] trig_functions
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 6 warnings.

Answer 1

Siete a conoscenza di documentazione del Sfinge? http://sphinx.pocoo.org/contents.html

In particolare, leggere la direttiva toctree: http://sphinx.pocoo.org/concepts.html

Si possono avere tutti i file che si desidera. Via toctree è possibile creare un unico documento da molte parti.

---

Si prega di realtà di lettura questo: http: // sfinge. pocoo.org/concepts.html#document-names

  

Dal momento che i file di origine resto può avere   diverse estensioni (alcune persone come   txt, alcuni, come .rst - l'estensione   può essere configurato con source_suffix)   e diversi sistemi operativi hanno percorso diverso   separatori, Sfinge li abstracts: tutto   “nomi documento” sono relativi alla   directory di origine, l'estensione è   spogliato e separatori di percorso sono   convertito in barre. Tutti i valori,   parametri e simili riferendosi   “Documenti” si aspettano che tale documento   nome.

     

Esempi di nomi dei documenti sono index,   library/zipfile, o   reference/datamodel/types. Nota che   non v'è alcuna slash iniziale.

Dal momento che si globbed con *, non è necessario elencare i file.

Se si desidera elencare i file, si prega di realtà lettura e seguire le regole di cui sopra.