В каких файлах я должен указывать VCS игнорировать при использовании Sphinx для документации?

Я хочу начать использовать Sphinx для документирования моего проекта. Я сказал Sphinx использовать отдельные каталоги источников и сборки во время sphinx-quickstart. Теперь мой макет каталога заключается в следующем:В каких файлах я должен указывать VCS игнорировать при использовании Sphinx для документации?

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

Какие файлы должны быть исключены из хранилища VCS для проекта Sphinx (то есть, так как я использую Git, что я должен добавить к моему .gitignore файл)? Например, следует ли игнорировать каталог docs/build/, чтобы изменения в HTML-страницах, сгенерированных из Sphinx, не отслеживались?

источник

2012-03-05 gotgenes

Если вы посмотрите на содержимое Makefile вы увидите что-то выглядит следующим образом:

BUILDDIR  = build 

... 

clean: 
    -rm -rf $(BUILDDIR)/*

Это означает, что make clean просто удаляет каталог build так, что касается контроля версий, не обращая внимания на содержимое директорию build должно быть достаточно, как вы уже подозревали.

источник

2012-03-05 16:53:15 jcollado

Обратите внимание, что если вы используете [сфинкс-apidoc] (http://sphinx-doc.org/man/sphinx-apidoc.html), почти все (за исключением 'index.rst')' * .rst 'файлы в' docs' будут генерироваться и также могут быть проигнорированы. Я бы предложил правило игнорирования, например '/ docs/myproject. *'. – Bengt

Но если вы хотите сохранить окончательные файлы (html, pdf и т. Д.) Для пользователей, чтобы им не пришлось перестраивать документацию, тогда необходимо создать/должен быть зафиксирован, но каждый файл в сборке/необходим для чтения документации , или их можно игнорировать? – Liam

Если вы создадите новый проект на GitHub, он предложит вам создать файл .gitignore с поддержкой Python. Этот файл включает в себя one reference для Sphinx сгенерированных файлов:

# Sphinx documentation 
docs/_build/

Примечание: Это предполагает, что вы принимаете по умолчанию при запуске sphinx-quickstart. Вы, возможно, потребуется настроить его в зависимости от того, как вы ответили на эти вопросы: путь

Root:
```
Enter the root path for documentation. 
> Root path for the documentation [.]: 
```
Это определяет путь, где хранится документация. Если вы сделали что-то отличное от docs, то вам нужно будет обновить .gitignore соответственно.
Сложение каталог:
```
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]: 
```
Если вы ответили n (по умолчанию), то Сфинкса создаст директорию для сборки на <root>/_build (ваши исходные файлы будут храниться непосредственно под <root>/).

Если вы ответили y, то Sphinx создаст каталог сборки по адресу <root>/build (ваши исходные файлы будут сохранены в <root>/source).

Обратите внимание на наличие/отсутствие ведущего подчеркивания; убедитесь, что соответствующий шаблон в вашем .gitignore соответствует.

источник

2016-12-04 15:14:38 user5568265

В каких файлах я должен указывать VCS игнорировать при использовании Sphinx для документации?

ответ

Смежные вопросы