- Git
- Sphinx
- Python 2.x
- Pip (for using/installing Sphinx)
- Text editor such as Atom, Notepad++, or SublimeText.
- Terminal/Powershell access (iTerm2, Terminal.app, etc.)
- Git Desktop client (if you prefer a GUI instead of a shell prompt). Suggested applications would be Github Desktop Client, Sourcetree, or Tower (Mac OS X Only).
- Edit files in
source
folder using a text editor such as Atom, SublimeText, or Notepad++. - Files are written in
reStructuredText
orMarkdown
syntax. Learn more aboutMarkdown
syntax at at DaringFireball or Markdown Cheatsheet. Github also has an official Markdown reference guide.
- All commits pushed to the Docs are first sent for CI Testing via Travis-CI
- If Travis-CI build passes a
Git Hook
runs to informRead The Docs
to initiate a new build. - If the new build succeeds on Read The Docs then it is live.
- Copyright 2016, All Rights Reserved - DockDogs Worldwide.