Планирование в Sphinx¶
Демонстрация использования системы документирования Sphinx-Doc для коллективной работы над плановыми документами.
Подробнее можно узнать по ссылке Рабочая документация в Sphinx.
Директивы для задач¶
С помощью расширения sphinx.ext.todo
и директивы .. todo::
в стиле информационных блоков Notes
можно обозначать описание задач в любых разделах документации.
Все описания задач можно объединить в динамически формируемый список задач, используя директиву .. todolist::
.
Чтобы директивы корректно работали, нужно в конфигурационный файл документации conf.py
включать следующие указания:
extensions = [
'sphinx.ext.todo'
]
todo_include_todos = True
todo_link_only = True
Список моих задач¶
План
Раздел - Электронный проектный офис - Запланировано
№ |
Дата |
Задача |
---|---|---|
Ответственный - Коля |
||
(60ч) ?.04.2020 |
Создание окружения для электронных задач |
|
(5мин) ?.04.2020 |
Создание ветки для изменений |
|
(5мин) ?.04.2020 |
Объединение изменений |
Раздел - Электронный проектный офис - Сделано
№ |
Дата |
Задача |
---|---|---|
Ответственный - Вася |
||
(60ч) ?.04.2020 |
Создание окружения для электронных задач |
|
Ответственный - Петя |
||
(5мин) ?.04.2020 |
Создание ветки для изменений |
|
(5мин) ?.04.2020 |
Объединение изменений |
План
Раздел - Рабочая документация в Sphinx - Критично (класс todo-danger)
№ |
Дата |
Задача |
---|---|---|
Ответственный - в поиске |
||
не определена |
Текст |
Раздел - Рабочая документация в Sphinx - В ожидании (класс todo-warning)
№ |
Дата |
Задача |
---|---|---|
Ответственный - в поиске |
||
не определена |
Текст |
Раздел - Рабочая документация в Sphinx - Намечено (класс todo-tip)
№ |
Дата |
Задача |
---|---|---|
Ответственный - в поиске |
||
не определена |
Текст |