Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

😎(docs) consider switching to mkdocs #12

Open
4 tasks
jmaupetit opened this issue Mar 26, 2018 · 0 comments
Open
4 tasks

😎(docs) consider switching to mkdocs #12

jmaupetit opened this issue Mar 26, 2018 · 0 comments
Assignees

Comments

@jmaupetit
Copy link
Contributor

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

  • convert *.rst documentation files to *.md
  • remove Sphinx and it's dependencies (edx theme, etc.)
  • add mkdocs dependency and configure it
  • update documentation build & clean methods (Makefile)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants