Sphinx

Cuando se crea por primera vez, su propósito principal era servir como un generador de documentación para Python 's propio código.
Desde entonces, el proyecto ha alcanzado un estatus de culto en el mundo del desarrollo, siendo una de las influencias más referenciados en generadores de documentación más automáticos de todo, sin importar el idioma.
Hoy en día, además de sólo Python, Esfinge también se puede utilizar con C y C ++ código también.

¿Qué hay de nuevo en esta versión:

• Añadir directivas de conveniencia y roles al dominio del C ++: directiva `` cpp: var`` como alias de `` cpp: member``, papel ``: cpp: var`` como alias de ``: cpp: miembro `` y `papel any` de referencias cruzadas a cualquier ++ declaraction C.
• El: confval: `valor config source_suffix` ahora puede ser una lista de varios sufijos
.
• Añadir la capacidad de especificar los analizadores de código de origen con el sufijo: confval:. `Valor config source_parsers`
• Un nuevo constructor, AppleHelpBuilder, ha añadido que construye de Apple Ayuda Books.

¿Qué hay de nuevo en la versión 1.2.3 / 1.3b3:

• Añadido `` tupla sphinx.version_info`` para la comprobación programática de la versión Esfinge.

¿Qué hay de nuevo en la versión 1.1.3:

• Solucionado el fallo con algunos ajustes de: confval:. Modindex_common_prefix` `
• Fijo manejo de `` -D`` y `` opciones -A`` en Python 3.
• Reconocida y advertir sobre toctrees circulares, en vez de correr en errores de recursividad.
• Restaurar compatibilidad con docutils tronco.
• Fijos HtmlHelp enlaces de entrada de índice de nuevo.
• inheritance_diagram Fijo elevar errores de atributos en órdenes internas.
• choques fijos al poner comentarios o términos solitarios en un glosario.
• ayuda HTML Fijo mapeo idioma / codificación para todos Esfinge apoyó idiomas.

¿Qué hay de nuevo en la versión 1.1:

• Características añadido:
• Soporte 3.x Agregado Python.
• Nuevos constructores y subsistema.
• cambios incompatibles:
• El: primera: dir: `py: Directiva module` no lo hace su salida de` `valor de opción platform`` más. (Era la única cosa que la directiva hizo de salida, y por lo tanto bastante inconsistente.)
• Soporte eliminado versiones de dependencia de edad.
• Nuevos escenarios:
• Añadido localidad sueca.
• Añadido localidad iraní.
• Añadido localidad letona.
• Añadido localidad nepalí.
• Alta configuración regional coreana.
• Añadido localidad de Estonia.

¿Qué hay de nuevo en la versión 1.0.8:

• rastreos Fix para AttributeErrors en generación autosummary.
• Fijar la `` abbr`` papel cuando la abreviatura tiene saltos de línea en el mismo.
• Fijar los enlaces para resultados con tipos de objetos personalizados buscar.
• números de línea Fix reportados en las advertencias sobre referencias indefinidas.
• C ++ definiciones Fix matriz y argumentos de plantilla que no se escriben los nombres.
• Permitir notas al pie en los encabezados de sección en la salida LaTeX.
• Permitir palabras clave para vincularse a través intersphinx.
• Permitir caracteres Unicode en la lista de nombres simbólicos de producción.
• Añadir visitantes ficticias para los nodos graphviz para el texto y el hombre.
• Fix bug imagen duplicación de archivos.
• Fix análisis de múltiples firmas en el dominio C ++.
• No haga caso de archivos de bloqueo de Emacs en la búsqueda de archivos de origen.
• Permitir extensión .pyw para módulos importables en autodoc.
• Uso `` $ (MAKE) `` en el inicio rápido generados Makefiles.
• Haz tu barra lateral ancho cuadro de búsqueda consistente en los navegadores.
• Fix espaciamiento de figuras centradas en la salida HTML.
• Con seguridad codificar mensajes SphinxError al imprimir a sys.stderr.
• error de salida LaTeX Fix con un documento sin secciones, sino un destino del enlace.
• correctamente el tratamiento de descriptores incorporados método como métodos en autodoc.
• Detener monkeypatching el módulo TextWrap Python.
• Viewcode ahora funciona correctamente con los archivos de origen que tienen codificación no ASCII.
• Respetar la opción flag `` noindex`` en py:. Directivas módulo
• IndexErrors Fix cuando entre ellos no existente con líneas: primera: dir: `literalinclude`.

Cuerdas
• El respeto de función personalizada / parámetro separador método.
• incompatibilidad JS Fix con jQuery & gt;. = 1.5
• Fijar doble codificación hecho al escribir HTMLHelp HHK archivos.
• No aplique SmartyPants en bloques literales analizados.
• dominio C ++ es ahora compatible con las definiciones de la matriz.

¿Qué hay de nuevo en la versión 1.0.6:

• Fix rastreo en el dominio de Python para objetivos de referencia cruzada vacías.
• Solucionar problemas de visualización de bloques literales en los navegadores Chrome.
• Soporte ordenar un rango limitado de caracteres acentuados en el índice general y el glosario.
• Trate de decodificación `` -D`` y `` argumentos de línea de comandos -A`` con codificación preferida de la configuración regional.
• Observar: confval:. `Locale_dirs` cuando se busca el archivo de traducciones JS
• Añadir código especial para un mejor soporte de documentos japoneses en el constructor de LaTeX.
• La regresión de # 77: Si sólo hay un parámetro dado con ``: param:. `` Marcado, la lista de viñetas está suprimida de nuevo
• Fijar falta saltos de párrafo en la producción de látex en ciertas situaciones.
• Emitir el evento `` autodoc-proceso-docstring`` incluso para objetos sin una cadena de documentación para que pueda agregar contenido.
• En el generador de LaTeX, no sólo los bloques literales requieren diferente manejo de mesa, sino también algunos otros elementos de bloque en listas como bastantes.
• rastreos Fix en la extensión viewcode para objetos de Python que no cuentan con una firma válida.
• Fix reportajes extraños de los números de línea para las advertencias generadas a partir docstrings AutoDoc-incluido, debido a un comportamiento diferente dependiendo de la versión docutils.
• Varias correcciones al dominio C ++.

¿Qué hay de nuevo en la versión 1.0.5:

• Añadir estilos CSS requeridos por docutils 0.7 para las imágenes y figuras alineadas.
• En el Makefile generado por la salida LaTeX, no elimine los archivos pdf en limpio; que podrían ser necesarias las imágenes.
• salida LaTeX Fix generado para bloques de línea.
• Permitir `` .pyw`` como una extensión de archivo de origen.

¿Qué hay de nuevo en la versión 1.0.4:

• inventarios intersphinx abiertas en modo binario en Windows, desde la versión 2 contiene datos zlib-comprimido.
• Permitir dando URI no locales para archivos JavaScript, por ejemplo, en la extensión jsMath.
• rastreo Fix cuando `` intersphinx_mapping`` está vacía.

¿Qué hay de nuevo en la versión 1.0.3:

• Fix interna vs. distinción enlace externo para los enlaces que vienen de un docutils mesa-de-contenido.
• Fijar la opción `` maxdepth`` para el `` toctree () `` plantilla exigible cuando se utiliza con `` colapso = True``.
• accidente Fix analizar Python listas de argumentos que contienen corchetes en los literales de cadena.
• Fix regresión en la construcción de documentos LaTeX con figuras que no tienen títulos.
• diagramas de herencia Fix para las clases que no están estibables.
• Introducir color de fondo diferente para el botón de la barra lateral del colapso, por lo que es más fácil de ver.
• Corregir pequeños errores de diseño en varios temas incorporados.

¿Qué hay de nuevo en la versión 1.0.2:

• Fijar referencias cruzadas a objetos de tipos añadidos por el: func:. `~ Función API .Sphinx.add_object_type`
• Fix manipulación de los tipos de campo doc para distintos tipos de directiva.
• Permitir romper firmas largas, continuando con saltos de línea contragolpe-escapado.
• Fix estilo deseado de referencias dominio C (a causa de un choque espacio de nombres con estilos Pygments).
• Permita que las referencias a las PEP y RFC con anclajes explícitas.
• referencias LaTeX Fix a cifras.
• Cuando se realiza una búsqueda no exacta, sólo el partido determinado tipo de objeto.
• Aplicar búsqueda no exacta para los objetivos de referencia de Python con `` .name`` para módulos también.
• Fix accidente al duplicar un parámetro en una lista de información de campo.
• Fijar establecer el rol predeterminado a uno proporcionado por el `` extensión oldcmarkup``.
• Fix accidente cuando se instala json-py, que proporciona un `` módulo json`` pero es incompatible con simplejson.
• Fix manejo de la meta de nomenclatura en intersphinx.
• Fix la eliminación de ``! `` Para todas las funciones de referencias cruzadas.

¿Qué hay de nuevo en la versión 1.0.1:

• Fijar nombres de destino generados por objetos de dominio de descanso; que no están en el mismo espacio de nombres.
• Agregar idioma bengalí.
• Fix un error al analizar los nombres de objetos de JavaScript.
• Fix edificio con SingleHTMLBuilder cuando no hay toctree.
• nombres de visualización Fix para objetos vinculados al por intersphinx con objetivos explícitos.
• Fix edificio con el constructor JSON.
• hyperrefs Fix en las descripciones de objetos para LaTeX.

¿Qué hay de nuevo en la versión 1.0:

• general:
• Ha añadido un modo "quisquillosa" que emite advertencias para todas las referencias que faltan. Se activa la opción:: `modificador de línea de comandos o la -n`: confval:.` Valor config nitpicky`
• Añadido `` objetivo latexpdf`` de inicio rápido Makefile.
• marcado:
• El: primero: función: `menuselection` y: primero: función:.` Papeles guilabel` ahora soportan aceleradores ampersand
• Nueva sintaxis campo doc más compacto se reconoce ahora: ``: nombre de tipo param:. Description``
• Añadido `` opción pestaña width`` a: primera: dir:. `Directiva literalinclude`
• Añadido `` opción titlesonly`` a: primera: dir:. `Directiva toctree`
• Añadido el `prepend``` y `` opciones append`` a la: primera: dir:. `Directiva literalinclude`
• Todos DOCINFO metadatos se cifra ahora en los metadatos del documento, no sólo el autor.
• El: primero: función: `papel ref` ahora también puede hacer referencia a tablas por subtítulo
.
• El: primera: dir:. `Directiva include` ahora es compatible con rutas absolutas, que se interpretan como en relación con el directorio de origen
• En el dominio de Python, referencias como ``: func: `. .name``` Ahora mira los nombres que coincidan con cualquier prefijo si no se encuentra una coincidencia directa
• Configuración:
• Agregado: confval:. `Valor config rst_prolog`
• Agregado: confval:. `Valor config html_secnumber_suffix` para controlar la sección de formato de numeración
• Agregado: confval:. `Valor config html_compact_lists` para controlar las listas compactos docutils 'cuentan
• El: confval: `valor config html_sidebars` ahora puede contener patrones como llaves, y los valores pueden ser listas que seleccionan de forma explícita que las plantillas de la barra lateral deben ser prestados. Eso significa que el contenido de la barra lateral orden interna se pueden incluir solamente selectivamente.
• : confval:. `Html_static_path` ahora puede contener entradas de archivos individuales
• El nuevo valor de configuración universal confval: `exclude_patterns` hace que la antigua: confval:` unused_docs`,: confval: `exclude_trees` y: confval:.` Exclude_dirnames` obsoletos
• Agregado: confval:. `Valor config html_output_encoding`
• Añadido el: confval: `valor config latex_docclass` e hizo el" twoside "opción documentclass reemplazable por" oneside "
.
• Añadido el: confval:. `Valor config trim_doctest_flags`, lo cual es cierto por defecto
• Agregado: confval:. `Valor config html_show_copyright`
• Agregado: confval: `latex_show_pagerefs` y: confval:.` Valores de configuración latex_show_urls`
• El comportamiento de: confval: `html_file_suffix` cambiado ligeramente: la cadena vacía ahora significa" sin sufijo "en lugar de" sufijo por defecto ", el uso de` `None`` para" sufijo predeterminado "
.
• Nuevos constructores:
• Ha añadido un constructor para el formato Epub.
• Ha añadido un constructor de páginas de manual.
• Ha añadido un constructor de HTML de un solo archivo.
• salida HTML:

Papeles
• En línea ahora obtienen una clase CSS con su nombre, lo que permite estilos para personalizar su apariencia. Los roles específicos de dominio tienen dos clases, `` y `` domain`` dominio rolename``.
• Referencias ahora obtienen la clase `` internal`` si son internos a la totalidad del proyecto, en lugar de internos a la página actual.
• Las referencias externas pueden ser de estilo diferente con la nueva opción de tema `` externalrefs`` para el tema por defecto.
• En el tema por defecto, la barra lateral puede experimentalmente continuación se hará plegable utilizando la nueva opción `` tema collapsiblesidebar``.
• Toctrees están envueltos en una `` div`` etiqueta con la clase `` toctree-wrapper`` en la salida HTML.
• El: Datos:. `Toctree` exigible en las plantillas de ahora tiene un argumento` `palabra clave maxdepth`` para controlar la profundidad del árbol generado
• El: Datos:. `Toctree` exigible en las plantillas ahora acepta un argumento` `palabra clave titles_only``
• Añadido `` bloque htmltitle`` en plantilla de diseño.
• En la búsqueda JavaScript, permite la búsqueda de nombres de objetos, incluyendo el nombre del módulo, como `` sys.argv``.
• Añadido nuevo tema `` haiku``, inspirada en la guía del usuario del Haiku OS.
• Añadido nuevo tema `` nature``.
• Añadido nuevo tema `` agogo``, creado por Andi Albrecht.
• Añadido nuevo tema `` scrolls``, creado por Armin Ronacher.
• Ha añadido un `` opción tema visitedlinkcolor`` con el tema por defecto.
• Mejora de la capacidad de respuesta de la página de búsqueda cargando thesearch índice de forma asíncrona.
• API de extensión:
• Añadido: evento:. `Html-cobrar-pages`
• Agregado: confval: `valor config y needs_sphinx`: meth:. ~` Método sphinx.application.Sphinx.require_sphinx` API solicitud
• Agregado: meth:. ~ `Método sphinx.application.Sphinx.add_stylesheet` API solicitud
• Extensiones:
• Añadido el: mod: `~ extensión sphinx.ext.viewcode`
.
• Añadido el: mod: `~ extensión sphinx.ext.extlinks`
.
• Se ha añadido soporte para el pedido fuente de miembros en autodoc, con `` autodoc_member_order = 'bysource'``.
• Agregado: confval:. `Autodoc_default_flags` valor de configuración, que puede ser utilizado para seleccionar banderas por defecto para todas las directivas AutoDoc
• Ha añadido un camino para intersphinx para referirse a las etiquetas de nombre en otros proyectos, y especificar el proyecto que desea establecer el vínculo.
• Autodoc ahora pueden documentar instancia atributos asignados en `` métodos __init__``.
• Muchas mejoras y correcciones a la: mod:. `~ Extensión sphinx.ext.autosummary`, gracias a Pauli Virtanen
• El: mod: `~ extensión sphinx.ext.graphviz` puede SVG ahora de salida en lugar de imágenes PNG, controlada por el confval:.` Valor config graphviz_output_format`
• Añadido `` opción alt`` a: primera: dir:. `Directivas de extensión graphviz`
• Añadido argumento `` exclude`` a: func:. .autodoc.between` `
• Traducciones:
• Alta traducción croata, gracias a Bojan Mihelac.
• añadida traducción al turco, gracias a Firat Ozgul.
• traducción Agregado catalán, gracias a Pau Fernández.
• Añadido traducción al chino simplificado.
• Alta traducción danesa, gracias a Hjorth Larsen.
• Alta traducción lituano, gracias a Dalius Dobravolskas.

¿Qué hay de nuevo en la versión 1.0b1:

• Soporte para dominios se ha añadido. Un dominio es un conjunto de directivas y roles que todos describen objetos pertenecientes juntos, por ejemplo, elementos de un lenguaje de programación. A pocos dominios orden interna se proporcionan: - Python - C - C ++ - Javascript - reStructuredText
• La edad de marcado para la definición y la vinculación con las directivas C no funcionará nunca más sin activar el `` extensión oldcmarkup``.
• Soporte eliminado versiones de dependencia de edad.
• Los elementos desaprobados eliminados.

¿Qué hay de nuevo en la versión 0.6.5:

• En autodoc, fijar la omisión de algunos miembros de módulo documentadas explícitamente el uso de comentarios de documentación.
• Fix recorte de barra de desplazamiento lateral con `` opción stickysidebar`` del tema por defecto.
• genera siempre nuevas líneas de UNIX en el Makefile de inicio rápido.
• Fix corriendo con `` -C`` bajo Windows.
• En autodoc, permite la personalización de la firma de un objeto donde falla el mecanismo incorporado.
• salida Arreglo para listas enumeradas con valores iniciales en LaTeX.
• Haga que el `` start-after`` y `` opciones de fin before`` a la `` trabajo Directiva literalinclude`` correctamente si no se usan juntos.
• Generación vínculo Fix en el constructor de LaTeX.

¿Qué hay de nuevo en la versión 0.6.4:

• Se ha mejorado el manejo de cadenas no Unicode en la configuración.
• OSErrors captura ocurren al llamar graphviz con argumentos que no entiende.
• Restaurar compatibilidad con Pygments & gt;. = 1.2
• Fix escapar de los objetivos de la producción hyperref LaTeX.
• Fix enlaces generados por el ``: doc: `` papel. Para la salida LaTeX
• Recoger TODO nodos después de todo el documento se ha leído; esto permite colocar referencias de sustitución en TODO artículos.
• No ignore un `` valor config today`` explícito en una compilación de LaTeX.
• El `` texto alt`` de diagramas de herencia es ahora mucho más limpia.
• Ignorar imágenes en títulos de la sección en la generación de enlaces subtítulos.
• mensajes de excepción Apoyo en las `` bloques testoutput`` del `extensión doctest```.
• bloques de línea están decoradas adecuadamente en la salida HTML.
• Hecho el trabajo `` valor config locale_dirs`` de nuevo.
• `` valores html_context`` dan en la línea de comandos a través de `` -A`` no debería invalidar otros valores dados en conf.py.
• Fix un error prevenir reconstrucciones incrementales para el `` constructor dirhtml``.
• Fix la mangling de cotizaciones en algunos bloques literales.
• Fix camino al índice de búsqueda para el `` constructor dirhtml``.
• Solucionar un problema de compatibilidad Jython: hacer que la dependencia de la `` módulo parser`` opcional
.
• En autodoc, coger todos los errores que se producen en el módulo de importación, no sólo `` ImportError``.
• Fijar el manejo de la no-datos, pero no los métodos descriptores en autodoc.
• Al copiar tiempos de archivo, ignore OSErrors planteadas por `` os.utime () ``.

Requisitos

• Pygments 1.2 o superior
• Jinja 2.3 o superior
• Docutils 0/7 o superior