Как использовать jekyll для написания документации проекта?

Question

Я пишу документацию для своего проекта. Я сделал свой проект на Python. Но я выбираю jekyll , чтобы записать документацию. Но я не нашел никакой полезной документации. Есть много основных вопросов, все еще движущихся вокруг меня. Например, как создать шаблон в jekyll и т. Д. Ребята, пожалуйста, предложите мне любую помощь, полную документацию или поделитесь своей идеей по документации, используя jkeyll.

Answer 1

Сейчас в 2014 году есть несколько шаблонов, я смотрю на

• http://bruth.github.io/jekyll-docs-template/
  • пример http://modeltree.harvest.io/ref/lookup-syntax.html
• https://github.com/clojurewerkz/docslate
  • пример http://clojuremongodb.info/
  • http://blog.clojurewerkz.org/blog/2013/06/15/how-we-document-our-projects-with-clojurewerkz-docslate/
• https://github.com/untyped/jekyll-docs
  • пример ?? https://mynaweb.com/help/quick-start

2015 добавление:

• https://github.com/tomjohnson1492/jekyll-doc из ответа Тома.

Я думаю, что должны быть другие, но не знаю.

Answer 2

Я разрабатываю тему джекила для технических документов здесь: https://github.com/tomjohnson1492/documentation-theme-jekyll.

Answer 3

Джекилл очень ориентирован на блог.Его можно использовать для создания статических html-страниц, но он не идеален для документирования программного проекта (если только вы не собираетесь документировать его в блоге).

Если ваш проект размещен на github, вы, вероятно,лучше использовать вики-сайт github, который сейчас достаточно продвинут.

Если вы все еще хотите автоматически генерировать документацию, есть лучшие решения - pydoc - это одно, но есть и другие., как Сфинкс , или самое новое прибытие, Dexy .