Когда дело касается больших таблиц, то их не очень удобно набирать вручную. Так как мне приходится работать в основном над переносом текста из LibreOffice (odf, doc, docx и т.д.), то я нашел быстрый, легкий и удобный способ с использованием CSV-таблиц и LibreOffice.
Показаны сообщения с ярлыком Python Sphinx. Показать все сообщения
Показаны сообщения с ярлыком Python Sphinx. Показать все сообщения
3 февраля 2015 г.
29 декабря 2014 г.
Руководство: Генератор документации Sphinx
Тот случай, когда для работы над одним руководством, приходится писать другое.
В руководстве подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs.
Доступно в трёх форматах — онлайн, HTML и ePub.
Структура руководства
В главе «Генератор документации Sphinx» описана установка и основные настройки Sphinx.
В главе «Стандартный синтаксис разметки reStructuredText» приведен стандартный синтаксис разметки reStructuredText. Глава «Конструкции разметки Sphinx» содержит описание дополнительных конструкции разметки, вносимых Sphinx. Данные конструкции значительно расширяют функционал reStructuredText, но не поддерживаются стандартной разметкой и поэтому не могут быть применены вне Sphinx.
Глава «Система управления версиями Git» является справочником по основным командам Git.
Глава «GitHub и Read The Docs» рассматривает веб-сервис для хостинга IT-проектов GitHub, сервис Read The Docs и их взаимодействие.
В главах «Известные проблемы» и «Часто задаваемые вопросы» описаны основные проблемы, с которыми я столкнулся.
Авторские права
Руководство распространяется на условиях лицензии «Attribution-ShareAlike» («Атрибуция — На тех же условиях») 4.0 Всемирная (CC BY-SA 4.0).
Содержание
Подписаться на:
Сообщения (Atom)