Installation on Windows

• Refer to Read the Docs user documentation
• Helpful screencast: Sphinx & Read the Docs

Install Python

download Python windows installer

(Optional) Install Babun

download Babun windows shell

Using reStructuredText

install sphinx:

$ pip install sphinx sphinx-autobuild
$ pip install sphinx-rtd-theme

make ‘docs’ directory:

$ cd <project-dir>
$ mkdir docs

run a script:

$ sphinx-quickstart

edit & build your documents:

$ make html

open in browser:

$ open build/html/index.html

Import to Read the Docs

• To import a repository, Sign up Read the docs & visit your dashboard.
• Click Import a project and Import Manually.
• Input Project Details including repository URL.
• For example, https://github.com/seungin/docs.git

Connect with Github Repository

• Go to repository settings
• Click Integrations & services and Add services
• Select Read the Docs