stsci.sphinxext містить розширення до Сфінкса побудувати документацію з STScI.
<Сильний> Використання
Ці інструкції охоплюють лише зміни від стандартних інструкцій Sphinx.
Створити нове дерево для документації Сфінкс, використовуючи sphinx_quickstart, як описано у введенні Сфінкса.
Імпорт налаштувань в stsci_sphinx conf.py вашого проекту, вставивши наступний рядок у верхній:
від stsci.sphinxext.conf імпорту *
Лінія "Розширення" в conf.py також повинні бути змінені таким чином не скасовує розширення, певні stsci.sphinxext. Наприклад, змінити:
Розширення = ['sphinx.ext.autodoc']
щоб:
Розширення + = ['sphinx.ext.autodoc']
. Крім того, закоментуйте рядок '' html_theme, так що ваш проект буде використовувати stsci.sphinxext один
Вимоги
- Python
- Сфінкс
- numpydoc
- Matplotlib
Коментар не знайдено