You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Writing documentation using Restructured Text format feels really painful nowadays. Now that PyPI natively supports rendering project descriptions formatted with markdown [1] and read the docs also supports markdown formatted documentation (using MkDocs), I think it's time to switch to markdown FTW!
Purpose
Writing documentation using Restructured Text format feels really painful nowadays. Now that PyPI natively supports rendering project descriptions formatted with markdown [1] and read the docs also supports markdown formatted documentation (using MkDocs), I think it's time to switch to markdown FTW!
[1] https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi
Proposal
*.rst
documentation files to*.md
mkdocs
dependency and configure itMakefile
)The text was updated successfully, but these errors were encountered: