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

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

14
jekyll project ruby

3 ответов

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

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

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

2

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

2015 добавил:

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

37

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

12