Ребята, привет! Нужно сделать какую-то простая документация в дорогу для python задача. Суть в том, что я часто в разъездах и нужен удобный способ вести документацию для проектов на Python. Желательно что-то легкое и юзер-френдли, чтоб в дороге все это легко редактировалось. Может, кто-то уже сталкивался с такой задачей? Поделитесь, пожалуйста, своими решениями, тулзами или либами, которые помогли решить такую проблему. А если есть какие-то примеры кода или фишки, вообще супер. Спасибо заранее!
Ждём вас в нашем чате в Телеграмм ==>> @pythoneer_chat
А ТАКЖЕ: Канал о Python, статьи и книги ==>> @pythoneer_ru
Советую глянуть что-то типа MkDocs – реально простой в использовании инструмент, который конвертит твои markdown-файлы в веб-страницы. Для простых задач самое то. Вот тебе код:
Устанавливаешь через pip и вперед, очень удобно, особенно в поездках, мало весит и редактировать файлы несложно.Программный код:name: my_documentation
site_name: Simple Documation
nav:
- Главная: index.md
Да, MkDocs тема! Плюс за использование markdown – писать документацию просто огонь!Сообщение от Эля
Сам пользуюсь Sphinx. Правда, он чуть посложнее, чем MkDocs, зато можно интегрировать с ReadTheDocs, и тогда документация вообще доступна из любого браузера. Это актуально, если часто в разъездах.
Точно, Sphinx + ReadTheDocs это уже следующего уровня, но тоже вариант для продвинутых!
Если коротко, и нужно что-то вообще легкое, то Gist на GitHub вполне подойдет. Выкладываешь свои markdown-файлы или просто текстовые заметки туда и все дела!
Gist спасает реально. Завел пару простых примеров и порядок.
Для таких случаев рекомендую Jupyter Notebooks. Код и описания в одном месте, можно пользоваться в браузере. Вот пример конфига:
Запустил на ноуте или сервере и все в одном месте, удобно!Программный код:c.NotebookApp.notebook_dir = \\"/path/to/your/notebooks\\"
c.NotebookApp.open_browser = False
Jupyter удобная вещь, каюсь, сам не так давно на него перешел. +1 к этому!
