Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I am writting a documentation for my project. I have done my project in python. But I choose jekyll to write down the documentation. But I didn’t found any helpful documentation. There is lots of basic question still moving around me. Such as how to generate template in jekyll etc. Guys please suggest me any help full documentation or share your idea on documentation using jkeyll.
Jekyll is very blog-oriented. It can be used to generate static html pages, but it isn’t ideal for documenting a software project (unless you intend to document it with a blog).
If your project is hosted on github, you will probably be better off by using github’s wiki, which is fairly advanced now.
If you still want to generate documentation automatically, there are better solutions out there – pydoc is one, but there are others, like Sphinx, or the newest arrival, Dexy.