¿Es una práctica común poner la documentation del código bajo control de versión?

Tengo un repository de github y recientemente noté que la documentation (que se creó a través de doxygen) también se ha subido al repository, porque está en la misma carpeta que el código fuente.

Ahora mi pregunta: ¿es una práctica común hacer esto, también para proporcionar la documentation (html, látex) en el repository?

Documentación "comstackda"

Supongo que ese es el caso, ya que mencionaste doxygen.

Si comstack la documentation automáticamente, no hay ninguna razón para ponerla bajo control de versión (por la misma razón no coloca binarys comstackdos bajo control de versión).

A menudo es recomendable ignorar la carpeta donde se repository/doc_build la documentation (es decir, repository/doc_build ), al crear un file .gitignore en la raíz del repository con esta línea:

 doc_build/ 

Esto evitará empujar esa carpeta accidentalmente.

Código fuente de documentation

Por otro lado, si un proyecto escribe documentation de código en un lenguaje de marcado (como Markdown, reStructunetworkingText, etc.), entonces tiene sentido poner el código fuente de la documentation bajo control de versión.

Tiene sentido porque de esa manera tienes un lugar único para queueborar con otros en la documentation (además de queueborar en el código). A menudo, un cambio en el código implica un cambio en la documentation: de esta manera puede hacer estos cambios en una única confirmación.

Incluso hay services como readthedocs.org para alojar su documentation que le permiten importarlo desde github (y rebuildlo automáticamente cuando lo cambie de github).

Como un ejemplo de eso, este proyecto github mantiene la documentation bajo control de versión (y también proporciona una versión comstackda):