yuvalofek / tutorial-sphinx-markdown

Document your project with Markdown, Sphinx, and Read the Docs

Let's be honest: we like the projects we use to be well-documented, but we almost never have time to document ours. How can we make writing documentation for our Data Science project be as pleasant as possible?

In this workshop you will document a Data Science project using Sphinx, leveraging Markdown and Jupyter notebooks, and we will deploy the result to Read the Docs.

Static slides available on nbviewer.

To clone locally:

$ git clone --recursive https://github.com/astrojuanlu/tutorial-sphinx-markdown.git

All the steps and notes of the tutorial are available on NOTES.md.

The tutorial-steps branch of lumache contains the finished version of the tutorial, with all the intermediate commits. You can use it for guidance if you get lost.