Jak używać jekyll do napisania dokumentacji projektu?

Question

Piszę dokumentację do mojego projektu. Zrobiłem mój projekt w Pythonie. Ale wybieram jekyll, aby zapisać dokumentację. Ale nie znalazłem żadnej przydatnej dokumentacji. Wciąż porusza się wokół mnie wiele podstawowych pytań. Takich jak generowanie szablonów w jekyll itp. Faceci proszę zasugerować mi jakąkolwiek pomoc pełną dokumentację lub podzielić się swoim pomysłem na dokumentacji przy użyciu jkeyll.

Answer 1

Jekyll jest bardzo zorientowany na blog. Może być używany do generowania statycznych stron HTML, ale nie jest idealny do dokumentowania projektu oprogramowania (chyba że masz zamiar udokumentować go za pomocą bloga).

Jeśli Twój projekt jest hostowany na githubie, prawdopodobnie lepiej będzie, jeśli użyjesz wiki githuba, które jest teraz dość zaawansowane.

Jeśli nadal chcesz wygenerować dokument automatycznie, istnieją lepsze rozwiązania - pydoc to jedno, ale są też inne, takie jak Sphinx lub najnowsze, Dexy.

Answer 2

Teraz w roku 2014 istnieje kilka szablonów, Patrzę na

• http://bruth.github.io/jekyll-docs-template/
  • przykład http://modeltree.harvest.io/ref/lookup-syntax.html
• https://github.com/clojurewerkz/docslate
  • przykład 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
  • przykład ?? https://mynaweb.com/help/quick-start

2015 dodając:

• https://github.com/tomjohnson1492/jekyll-doc z odpowiedzi od Toma.

Myślę, że powinny być inne, ale nie wiem.

Answer 3

Zajmuję się tworzeniem motywu jekyll dla dokumentów technicznych tutaj: https://github.com/tomjohnson1492/documentation-theme-jekyll.