Getting Started with Sphinx and readthedocs.org

  • new github repo
  • readthedocs.org account
  • install sphinx (debian package?)
  • https://read-the-docs.readthedocs.org/en/latest/getting_started.html
  • sphinx-quickstart
  • edit index.rst
  • run make html to check if it works
  • commit and push your files to Github (but without the HTML files!)
  • create a new project at readthedocs.org using your Github repo
  • go to Github admin section, then to service hooks, activate ReadTheDocs

TODO