Skip to content

Instantly share code, notes, and snippets.

View tonnydourado's full-sized avatar

Antonio Dourado tonnydourado

41 followers · 37 following
View GitHub Profile
@djetelina
djetelina / pyProjectManage.rst
Last active October 11, 2016 06:07
Feedback wanted
@rochacbruno
rochacbruno / markdocs_idea.md
Last active February 2, 2021 18:22
Using markdocs to Python documentation (markdown) - Idea - WIP

UNDER DEVELOPMENT HERE: https://github.com/rochacbruno/markdocs

Python documentation

I still think that the problem of lack of good documentation in the Python ecosystem is also related to .rst format and the use of complicated tools like Sphinx.

I'm enjoying writing functional documentation using Markdown in Rustlang, so I'll do experiments to have the same functionality in Python. Take a look at rustdoc and here an example of documentation site generated for a Rust crate using markdown comments.