¿Qué files debo decirle a mi VCS que ignore cuando use Sphinx para la documentation?

Quiero comenzar a usar Sphinx para documentar mi proyecto. Le dije a Sphinx que use directorys de compilation y fuente separados durante sphinx-quickstart . Ahora mi layout de directory es el siguiente:

 MyProject/ myproject/ __init__.py mymodule.py docs/ source/ .static/ .templates/ conf.py index.rst build/ Makefile 

¿Qué files deberían excluirse de un repository de VCS para un proyecto de Sphinx (es decir, dado que uso Git, qué debería agregar a mi file .gitignore )? Por ejemplo, ¿debería ignorar el directory docs/build/ para que no se rastreen los cambios en las páginas HTML generadas desde Sphinx?

Si echas un vistazo al contenido de Makefile verás algo de la siguiente manera:

 BUILDDIR = build ... clean: -rm -rf $(BUILDDIR)/* 

Esto significa que make clean simplemente elimina el directory de build , por lo que, con respecto al control de versiones, ignorar los contenidos del directory de build debería ser suficiente como ya sospechabas.

Si creas un nuevo proyecto en GitHub, te ofrecerá crear un file .gitignore sabor .gitignore para ti. Este file incluye una reference a los files generados por Sphinx:

 # Sphinx documentation docs/_build/ 

Nota: Esto supone que acepta los valores pnetworkingeterminados cuando ejecuta sphinx-quickstart . Es posible que deba ajustarlo según cómo haya respondido a estas preguntas:

  1. Ruta raíz

     Enter the root path for documentation. > Root path for the documentation [.]: 

    Esto determina la ruta donde se almacena la documentation. Si lo hizo algo distinto de docs , entonces deberá actualizar .gitignore consecuencia.

  2. Directorio de compilation:

     You have two options for placing the build directory for Sphinx output. Either, you use a directory "_build" within the root path, or you separate "source" and "build" directories within the root path. > Separate source and build directories (y/n) [n]: 

    Si respondió n (pnetworkingeterminado), Sphinx creará el directory de compilation en <root>/_build (sus files de origen se almacenarán directamente en <root>/ ).

    Si respondió y , Sphinx creará el directory de compilation en <root>/build (sus files fuente se almacenarán en <root>/source ).

    Tenga en count la presencia / ausencia del subrayado inicial; asegúrese de que el patrón correspondiente en su .gitignore coincida.