The website I built is totally open source, hence every piece of my code should be documented and available for contributors. #Sphinx and #ReadTheDocs are the perfect match for this circumstances. It automates the process of generating the HTML pages with #Sphinx and #ReadTheDocs implement continuous deployment getting the last version of my #GitHub master branch. Once configured, the only work I have is making docstrings, the hard work is done entirely by these two fantastic tools.

READ LESS
Welcome to drafthub’s documentation! — drafthub documentation (drafthub.readthedocs.io)
18 upvotes·2 comments·15.8K views
Bogdan Doicin
Bogdan Doicin
·
May 25th 2020 at 6:13AM

Great. Make sure you write the documentation in a manner so as many people understand it. I have experience with Python libraries which may be fantastic, but I don't understand a damn thing about how and where to start, what do the functions do and how to put them together.

·
Reply
Felipe Lincoln
Felipe Lincoln
·
May 26th 2020 at 7:43PM

I haven't written a single code docstring yet.

The readthedocs page has just been set up, I didn't even customize it. I will be working on it soon =)

·
Reply
Avatar of Felipe Lincoln