Dueling Dogs Online Help Documentation - http://help.duelingdogs.net/en/latest
- Git
- Sphinx or check the Sphinx Github Repository
- Python (for using Sphinx)
- 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).
- If you've never obtained the documentation before you'll want to clone the repository. The default branch is
master, this is good.$ [email protected]:duelingdogs/dueling-docs.git
- If you've already cloned the repository navigate to where this is in your computer using Terminal or Powershell. Once in this directory you'll be able to execute the following:
$ git fetch && git checkout master
- Edit files in
sourcefolder using a text editor such as Atom, SublimeText, or Notepad++. - Files are written in
reStructuredTextsyntax orMarkdown.
$ git commit -am "commit message documenting what you've changed"$ git push- Once pushed to
masterbranchTravis-CIwill attempt to compile the documentation via a combination of wizardry and science. - If Travis-CI is satisfied that the build compiles properly it will send it for compiling and deployment at ReadTheDocs
- Confirm updates are live & accessible via accessing http://help.duelingdogs.net. This may take a few minutes to fully deploy, please be patient. Check the
Travis-CIpage &ReadTheDocsbuild pages linked above.
- To view the latest documentation online simply visit http://help.duelingdogs.net.
- To download the latest documentation as a PDF for offline access visit http://readthedocs.org/projects/dueling-dogs-online-documentation/downloads/pdf/latest/
- Copyright 2015-2016, All Rights Reserved - Dueling Dogs, LLC.