¿se puede renombrar "tabla de contenido" en la barra lateral de sphinx?

Question

En general, ¿cómo cambia el nombre de los elementos predeterminados de Sphinx (por ejemplo, Quick Search a)? ¿Puedes?

Answer 1

Aquí es cómo se puede cambiar "Búsqueda rápida" a otra cosa anulando una plantilla:

1. Crear una carpeta llamada templates en el directorio del proyecto Esfinge.

2. Copia <Sphinx install dir>/themes/basic/searchbox.html a templates.

3. En conf.py, añadir

   templates_path = ["templates"] 
   

4. Renombrar 'Búsqueda rápida' a lo que usted quiere en la copia de searchbox.html.

Pero no lo haría de esta manera.

Un enfoque más flexible es crear un archivo MO gettext y configurar la configuración como se describe en the documentation for locale_dirs. De esta manera:

1. El archivo de plantilla <Sphinx install dir>/locale/sphinx.pot contiene todas las cadenas que se pueden traducir. Copie ese archivo a un archivo local sphinx.po.

2. Agregue sus cambios a sphinx.po.

3. Uso msgfmt.py para compilar sphinx.po en sphinx.mo.

4. Ponga sphinx.mo en el directorio apropiado (<your_locale_dir>/en/LC_MESSAGES para inglés).

Véase también http://docs.python.org/library/gettext.html#internationalizing-your-programs-and-modules.

Answer 2

De acuerdo con Sphinx config documentation, debería poder modificar las plantillas html o quizás apuntar a Sphinx a nuevas plantillas para lograr lo que intenta hacer trabajando en el html de las plantillas.

Las plantillas actuales tienen un título de búsqueda proporcionado en el contexto, aunque no estoy seguro de qué es lo que completa el valor de contexto para _ ('búsqueda'). Vago si usted podría intentar personalizarlo mediante la modificación del archivo de entorno local en /sphinx/sphinx/locale/sphinx.pot:

#: sphinx/themes/agogo/layout.html:49 sphinx/themes/basic/layout.html:137 
#: sphinx/themes/basic/search.html:11 sphinx/themes/basic/search.html:20 
msgid "Search" 
msgstr "" 

y decir msgstr "My alternative search" en lugar de msgstr "".