Permalink
Browse files

Adds docs

  • Loading branch information...
miped committed Mar 27, 2016
1 parent 1b6db55 commit 2ec736d82d56941a0836e287907aa565bde579b4
Showing with 2,598 additions and 0 deletions.
  1. +7 −0 .gitignore
  2. +153 −0 docs/Makefile
  3. 0 docs/_static/EMPTY
  4. +17 −0 docs/_templates/layout.html
  5. +26 −0 docs/_themes/armstrong/LICENSE
  6. +70 −0 docs/_themes/armstrong/README.rst
  7. +48 −0 docs/_themes/armstrong/layout.html
  8. +781 −0 docs/_themes/armstrong/static/rtd.css_t
  9. +65 −0 docs/_themes/armstrong/theme.conf
  10. +66 −0 docs/_themes/armstrong/theme.conf.bak
  11. +252 −0 docs/conf.py
  12. +120 −0 docs/src/commands.rst
  13. +128 −0 docs/src/customizations.rst
  14. BIN docs/src/img/tutorial/tutorial01.png
  15. BIN docs/src/img/tutorial/tutorial02.png
  16. BIN docs/src/img/tutorial/tutorial03.png
  17. BIN docs/src/img/tutorial/tutorial04.png
  18. BIN docs/src/img/tutorial/tutorial05.png
  19. BIN docs/src/img/tutorial/tutorial06.png
  20. BIN docs/src/img/tutorial/tutorial07.png
  21. BIN docs/src/img/tutorial/tutorial08.png
  22. BIN docs/src/img/tutorial/tutorial09.png
  23. BIN docs/src/img/tutorial/tutorial10.png
  24. BIN docs/src/img/tutorial/tutorial11.png
  25. BIN docs/src/img/tutorial/tutorial12.png
  26. BIN docs/src/img/tutorial/tutorial13.png
  27. BIN docs/src/img/tutorial/tutorial14.png
  28. BIN docs/src/img/tutorial/tutorial15.png
  29. BIN docs/src/img/tutorial/tutorial16.png
  30. BIN docs/src/img/tutorial/tutorial17.png
  31. BIN docs/src/img/tutorial/tutorial18.png
  32. BIN docs/src/img/tutorial/tutorial19.png
  33. BIN docs/src/img/tutorial/tutorial20.png
  34. BIN docs/src/img/tutorial/tutorial21.png
  35. BIN docs/src/img/tutorial/tutorial22.png
  36. BIN docs/src/img/tutorial/tutorial23.png
  37. BIN docs/src/img/tutorial/tutorial24.png
  38. BIN docs/src/img/tutorial/tutorial25.png
  39. BIN docs/src/img/tutorial/tutorial26.png
  40. BIN docs/src/img/tutorial/tutorial27.png
  41. BIN docs/src/img/tutorial/tutorial28.png
  42. BIN docs/src/img/tutorial/tutorial29.png
  43. BIN docs/src/img/tutorial/tutorial30.png
  44. BIN docs/src/img/tutorial/tutorial31.png
  45. +34 −0 docs/src/index.rst
  46. +64 −0 docs/src/keyboard_shortcuts.rst
  47. +34 −0 docs/src/more_information.rst
  48. +10 −0 docs/src/plugins.rst
  49. +19 −0 docs/src/plugins/gitflow.rst
  50. +17 −0 docs/src/plugins/le-git.rst
  51. +157 −0 docs/src/quickstart.rst
  52. +91 −0 docs/src/troubleshooting.rst
  53. +266 −0 docs/src/tutorial.rst
  54. +147 −0 docs/sublimedoc/__init__.py
  55. +11 −0 docs/sublimedoc/dummy/sublime.py
  56. +15 −0 docs/sublimedoc/dummy/sublime_plugin.py
View
@@ -0,0 +1,7 @@
+.DS_Store
+.cache
+.coverage
+coverage.xml
+*.pyc
+*.sublime-project
+docs/_build/
View
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS = -a -E -c .
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) src
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SublimeGit.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SublimeGit.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/SublimeGit"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SublimeGit"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
View
No changes.
@@ -0,0 +1,17 @@
+{% extends "!layout.html" %}
+
+{%- block extrahead %}
+ {{ super() }}
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-37799296-1']);
+ _gaq.push(['_setDomainName', 'sublimegit.net']);
+ _gaq.push(['_setAllowLinker', true]);
+ _gaq.push(['_trackPageview']);
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+{% endblock %}
@@ -0,0 +1,26 @@
+Copyright (c) 2011 Bay Citizen & Texas Tribune
+
+Original ReadTheDocs.org code
+Copyright (c) 2010 Charles Leifer, Eric Holscher, Bobby Grace
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
@@ -0,0 +1,70 @@
+Armstrong Sphinx Theme
+======================
+Sphinx theme for Armstrong documentation
+
+
+Usage
+-----
+Symlink this repository into your documentation at ``docs/_themes/armstrong``
+then add the following two settings to your Sphinx ``conf.py`` file::
+
+ html_theme = "armstrong"
+ html_theme_path = ["_themes", ]
+
+You can also change colors and such by adjusting the ``html_theme_options``
+dictionary. For a list of all settings, see ``theme.conf``.
+
+
+Defaults
+--------
+This repository has been customized for Armstrong documentation, but you can
+use the original default color scheme on your project by copying the
+``rtd-theme.conf`` over the existing ``theme.conf``.
+
+
+Contributing
+------------
+
+* Create something awesome -- make the code better, add some functionality,
+ whatever (this is the hardest part).
+* `Fork it`_
+* Create a topic branch to house your changes
+* Get all of your commits in the new topic branch
+* Submit a `pull request`_
+
+.. _Fork it: http://help.github.com/forking/
+.. _pull request: http://help.github.com/pull-requests/
+
+
+State of Project
+----------------
+Armstrong is an open-source news platform that is freely available to any
+organization. It is the result of a collaboration between the `Texas Tribune`_
+and `Bay Citizen`_, and a grant from the `John S. and James L. Knight
+Foundation`_. The first stable release is scheduled for September, 2011.
+
+To follow development, be sure to join the `Google Group`_.
+
+``armstrong_sphinx`` is part of the `Armstrong`_ project. Unless you're
+looking for a Sphinx theme, you're probably looking for the main project.
+
+.. _Armstrong: http://www.armstrongcms.org/
+.. _Bay Citizen: http://www.baycitizen.org/
+.. _John S. and James L. Knight Foundation: http://www.knightfoundation.org/
+.. _Texas Tribune: http://www.texastribune.org/
+.. _Google Group: http://groups.google.com/group/armstrongcms
+
+
+Credit
+------
+This theme is based on the the excellent `Read the Docs`_ theme. The original
+can be found in the `readthedocs.org`_ repository on GitHub.
+
+.. _Read the Docs: http://readthedocs.org/
+.. _readthedocs.org: https://github.com/rtfd/readthedocs.org
+
+
+License
+-------
+Like the original RTD code, this code is licensed under a BSD. See the
+associated ``LICENSE`` file for more information.
@@ -0,0 +1,48 @@
+{% extends "basic/layout.html" %}
+
+{% set script_files = script_files + [pathto("_static/searchtools.js", 1)] %}
+
+{% block htmltitle %}
+{{ super() }}
+
+<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/>
+
+{% endblock %}
+
+{% block footer %}
+<div class="footer">
+{%- if show_copyright %}
+ {%- if hasdoc('copyright') %}
+ {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+ {%- else %}
+ {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+ {%- endif %}
+{%- endif %}
+{%- if last_updated %}
+ {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+{%- endif %}
+{%- if show_sphinx %}
+ {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+{%- endif %}
+{%- if theme_show_rtd %}
+ {% trans %}<br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a>{% endtrans %}
+{% endif %}
+</div>
+
+
+{% if theme_analytics_code %}
+<!-- Google Analytics Code -->
+<script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', '{{ theme_analytics_code }}']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+</script>
+{% endif %}
+
+{% endblock %}
Oops, something went wrong.

0 comments on commit 2ec736d

Please sign in to comment.