Localización de las fuentes de Sphinx para mis notas

StackOverflow https://stackoverflow.com/questions/1690757

  •  18-09-2019
  •  | 
  •  

Pregunta

¿Cómo se puede fijar la advertencia de la Esfinge en la parte inferior?

Estoy tratando de tener mis notas Python en Sphinx. Tengo mis notas en archivos separados en el mismo nivel que el directorio index.rst .

consigo las siguientes advertencias después de la construcción de HTML

La advertencia 

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

en

El mensaje completo en la construcción 

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.
¿Fue útil?

Solución

¿Es consciente de la documentación de la esfinge? http://sphinx.pocoo.org/contents.html

En concreto, leer sobre la directiva toctree: http://sphinx.pocoo.org/concepts.html

Puede tener tantos archivos como desee. Via toctree puede crear un documento único de muchas partes.

Por favor realidad Leer esto: http: // esfinge. pocoo.org/concepts.html#document-names

  

Dado que los archivos de origen resto puede tener   extensiones diferentes (algunas personas como   .txt, algunos como .RST - la extensión   se puede configurar con source_suffix)   y diferentes sistemas operativos tienen diferentes camino   separadores, Sphinx los resúmenes: todos   “nombres de los documentos” son en relación con el   directorio de origen, la extensión es   desnudaron y separadores de ruta son   convertidos a barras. Todos los valores,   parámetros y cosas por el estilo en referencia a   “Documentos” esperan que tal documento   nombre.

     

Ejemplos de nombres de documentos son index,   library/zipfile, o   reference/datamodel/types. Tenga en cuenta que   no hay una barra inicial.

Desde que globbed con *, no es necesario hacer una lista de los archivos.

Si desea una lista de sus archivos, por favor realidad leer y seguimiento las reglas anteriores.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top