--- /dev/null
+#
+# Makefile for The Hydra Suite
+#
+
+.PHONY: publish docs
+
+publish: docs
+ @rsync -avz --delete site/ hydra:/var/sites/hidra/www/
+ @rsync -avz --delete slides/ hydra:/var/sites/hidra/www/slides/
+
+docs:
+ @mkdocs build
+++ /dev/null
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: publish
-
-publish: html
- @rsync -avz --delete _build/html/ hydra:/var/sites/hidra/www/
-
-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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
- @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 " xml to make Docutils-native XML files"
- @echo " pseudoxml to make pseudoxml-XML files for display purposes"
- @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/HydraSuite.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/HydraSuite.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/HydraSuite"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/HydraSuite"
- @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."
-
-latexpdfja:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through platex and dvipdfmx..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
- @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."
-
-xml:
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+++ /dev/null
-Subproject commit eeff5645dc4eeb7a5c4910d39c17131961045dce
+++ /dev/null
-# -*- coding: utf-8 -*-
-#
-# Hydra Suite documentation build configuration file, created by
-# sphinx-quickstart on Sat May 14 10:43:17 2016.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys
-import os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = []
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Hydra Suite'
-copyright = u'2016, Silvio Rhatto'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.2.6'
-# The full version, including alpha/beta/rc tags.
-release = '0.2.6'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build', '_themes']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#html_theme = 'default'
-html_theme = "sphinx_rtd_theme"
-html_theme_path = ["_themes/sphinx_rtd_theme", ]
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-html_logo = '_static/logo.png'
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'HydraSuitedoc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- ('index', 'HydraSuite.tex', u'Hydra Suite Documentation',
- u'Silvio Rhatto', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', 'hydrasuite', u'Hydra Suite Documentation',
- [u'Silvio Rhatto'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', 'HydraSuite', u'Hydra Suite Documentation',
- u'Silvio Rhatto', 'HydraSuite', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
d="m 347.94552,212.9192 c -3.575,-1.53226 -8.3,-3.72385 -10.5,-4.8702 -2.2,-1.14635 -8.3469,-4.18732 -13.65979,-6.7577 -10.40788,-5.03535 -22.57529,-15.16827 -28.37696,-23.6321 -1.62979,-2.37763 -4.89086,-6.34907 -7.24683,-8.82542 -2.35597,-2.47634 -5.86549,-7.33117 -7.79894,-10.7885 -1.93345,-3.45733 -3.87827,-6.28605 -4.32182,-6.28605 -0.89716,0 -2.07758,10.62317 -2.08855,18.79581 -0.005,3.71954 -0.75122,6.69361 -2.50711,9.99204 -1.375,2.58293 -2.5,5.71672 -2.5,6.96398 0,1.24726 -0.9,3.03835 -2,3.9802 -1.1,0.94185 -2,2.32085 -2,3.06445 0,0.7436 -2.5435,4.01859 -5.65222,7.27776 -6.45546,6.76787 -7.53963,7.00338 -20.67244,4.49066 -12.37729,-2.36817 -20.36808,-7.91892 -25.37043,-17.62341 -2.3544,-4.5675 -2.78133,-6.55984 -2.65808,-12.40438 0.13086,-6.20529 0.43614,-7.21173 2.80577,-9.25 3.20711,-2.75864 6.65009,-2.93611 8.89241,-0.45837 2.14402,2.36911 2.06096,4.0954 -0.34501,7.17126 -2.69873,3.45013 -2.4845,6.04288 0.87585,10.59996 7.27271,9.86279 13.14158,12.88662 23.70572,12.21395 5.40992,-0.34448 6.85428,-0.85706 9.46836,-3.3602 4.40545,-4.21848 8.74964,-13.98962 9.93474,-22.34566 1.57078,-11.07542 -1.31697,-39.79447 -4.49795,-44.73275 -0.75274,-1.16858 -2.31379,-6.34358 -3.46899,-11.5 -1.1552,-5.15641 -2.77117,-11.93114 -3.59105,-15.054947 -0.81987,-3.123804 -1.68479,-10.323804 -1.92205,-16 -0.23725,-5.676196 -0.70196,-13.020356 -1.03269,-16.320356 -0.98555,-9.833883 3.21285,-26.227962 8.83519,-34.5 4.47608,-6.585561 9.25189,-11.047533 17.69287,-16.530192 8.54059,-5.547356 12.17293,-6.9866211 20.11671,-7.9709617 18.0669,-2.2387319 49.86297,15.4035527 57.73411,32.0341927 1.29295,2.731829 2.75545,5.748355 3.25,6.703392 1.21677,2.349743 1.13842,9.44803 -0.13046,11.81896 -2.52096,4.710452 -12.4699,6.423865 -19.75248,3.401785 -4.26145,-1.768394 -15.53872,-12.45272 -21.39267,-20.267885 -5.1,-6.808615 -6.95719,-11.32562 -6.66847,-16.218869 0.12709,-2.153774 -0.0816,-4.228579 -0.46366,-4.610677 -1.50906,-1.509063 -12.33117,-2.297841 -17.44451,-1.271458 -9.03956,1.814481 -22.07537,10.570709 -25.96793,17.442808 -2.34078,4.132533 -4.62573,11.125824 -5.86812,17.959909 l -0.72553,3.991004 3.57073,-3.135145 c 4.97377,-4.367028 9.85541,-5.784244 19.87404,-5.769744 8.91298,0.0129 11.8001,0.815005 22.24369,6.179789 8.27107,4.248772 14.6266,9.287198 26.92716,21.346816 11.46656,11.241951 11.82561,11.723936 11.51648,15.459449 -0.26555,3.208713 -0.99031,4.318418 -4.31909,6.613054 -7.10903,4.900486 -17.21604,3.053496 -28.04954,-5.125878 -7.56937,-5.714935 -8.91835,-8.626999 -8.93599,-19.290403 l -0.0145,-8.740054 -3.5,-1.840945 c -6.2478,-3.286243 -12.62201,-4.496211 -20.53405,-3.897825 -8.22765,0.622256 -11.66594,2.479552 -14.66845,7.923601 -2.11655,3.837677 -1.14409,6.602047 5.49517,15.620843 8.31406,11.293846 19.79643,18.259847 38.70733,23.482507 15.11564,4.17453 30,6.63086 30,4.95084 0,-1.63232 14.4911,-10.92481 20.60219,-13.211265 7.31861,-2.738242 15.18873,-2.055379 20.82663,1.807055 9.35128,6.40641 10.2177,18.738 1.62412,23.11559 -5.65541,2.88089 -20.7115,3.59049 -33.72163,1.58934 -19.23555,-2.95872 -41.72751,-7.7681 -45.31088,-9.68866 -1.91994,-1.02904 -4.0201,-1.87097 -4.66701,-1.87097 -3.81891,0 -18.35398,-7.6342 -24.04054,-12.62673 l -6.31288,-5.542397 0,3.019462 c 0,4.477755 1.63064,7.998545 6.37171,13.757495 6.08618,7.39282 16.46956,15.70782 27.62829,22.12472 6.47806,3.72525 33.47835,11.90662 47.24139,14.31464 7.04117,1.23194 10.31702,3.6471 13.79331,10.16929 2.76123,5.1806 2.98393,6.19704 2.0066,9.15838 -1.92074,5.8199 -8.14702,9.61869 -18.24783,11.1334 -4.03512,0.60511 -5.57585,0.24371 -11.96256,-2.80598 -4.032,-1.9253 -7.8299,-3.65844 -8.43978,-3.85141 -2.20713,-0.69837 -10.39113,-8.19891 -10.39113,-9.52334 0,-2.72534 -3.35297,-13.32753 -4.21486,-13.32753 -2.64676,0 -25.05059,-11.91915 -29.53514,-15.71311 -2.8875,-2.44285 -5.25,-3.88379 -5.25,-3.2021 0,1.7142 8.27638,15.86234 14.59518,24.94985 8.64486,12.4328 19.46499,24.06677 27.63665,29.71536 4.17726,2.8875 7.8065,5.25 8.06497,5.25 0.25846,0 0.69331,-0.85417 0.96632,-1.89815 0.273,-1.04399 1.65885,-2.65985 3.07966,-3.5908 2.21966,-1.45437 3.3244,-1.53369 7.84819,-0.56351 11.85627,2.54271 15.95275,4.25847 21.81469,9.13683 6.93076,5.76784 8.31001,9.62329 5.53481,15.4716 -2.91717,6.14746 -8.45749,6.9256 -18.54047,2.604 z m 8,-9.06119 c 0,-1.22931 -6.70464,-5.09878 -8.83465,-5.09878 -0.94619,0 -2.60797,-0.60145 -3.69284,-1.33657 -2.25107,-1.52532 -12.49835,-4.97092 -13.0734,-4.39587 -0.27189,0.27189 23.05448,11.00133 25.35089,11.66066 0.1375,0.0395 0.25,-0.33377 0.25,-0.82944 z m -3.321,-34.29967 c 4.1362,-1.49567 4.0866,-2.54244 -0.29302,-6.18413 l -3.46962,-2.88503 -2.50313,2.35156 c -3.12616,2.93688 -6.0772,1.634 -5.62289,-2.48251 0.32492,-2.9441 0.48288,-2.86546 -9.29034,-4.62547 -3.85,-0.69333 -7.5625,-1.46915 -8.25,-1.72405 -2.50465,-0.92864 -1.1589,2.8456 2.43179,6.82006 7.1295,7.8915 18.84168,11.67865 26.99721,8.72957 z m 24.50019,-53.57663 c 1.9794,-1.98199 -0.24533,-4.54166 -4.77212,-5.4906 -3.34954,-0.70215 -4.10285,-0.52741 -5.27904,1.22455 -1.59898,2.3817 -5.65397,2.72134 -6.48966,0.54357 -0.79648,-2.07559 -3.52072,-1.86907 -7.52188,0.57023 -5.73401,3.49574 -1.81434,4.81547 13.58517,4.57403 5.96054,-0.0935 9.65107,-0.59425 10.47753,-1.42178 z M 332.94552,92.020761 c 0,-0.406156 -2.08227,-2.623244 -4.62726,-4.926863 -3.98701,-3.608861 -4.96719,-4.059161 -7.08392,-3.254381 -1.35116,0.51371 -2.86889,0.679241 -3.37274,0.367847 -1.62972,-1.007226 -0.9702,1.192912 0.8519,2.84189 3.77341,3.414889 14.23202,7.068274 14.23202,4.971507 z m -17,-11.432793 c 0,-1.744193 -0.74474,-3.994193 -1.65499,-5 -3.47958,-3.844894 -4.49343,-1.051122 -1.73107,4.77013 2.02239,4.261859 3.38606,4.354435 3.38606,0.22987 z m 34,-28.151781 c 0,-1.637282 -8.89899,-15.67696 -9.93677,-15.67696 -0.41429,0 -1.56774,0.9 -2.56323,2 -0.99549,1.1 -2.3994,2 -3.1198,2 -2.19537,0 -3.61317,-3.696177 -2.33436,-6.085646 0.61391,-1.147106 0.86829,-2.333562 0.56528,-2.636569 -1.34068,-1.340683 -13.04908,-8.173162 -13.40165,-7.820586 -2.02747,2.027468 12.17967,20.858096 19.45989,25.792801 5.59179,3.790253 11.33064,5.019482 11.33064,2.42696 z"
id="path3049"
inkscape:connector-curvature="0"
- inkscape:export-filename="/home/rhatto/apps/hydra/doc/_static/logo.png"
+ inkscape:export-filename="/home/rhatto/apps/hydra/docs/assets/logo.png"
inkscape:export-xdpi="99.959999"
inkscape:export-ydpi="99.959999" />
</svg>
-Hydra Suite - Command and Control
-=================================
+# Hydra Suite - Command and Control
Hydra is a suite for orchestration and management of machines composed of
the following basic commands:
* `hydra`: act on at set of hosts.
* `hydras`: act on a superset of hosts.
-See further documentation for details:
-
-.. toctree::
- :maxdepth: 1
-
- install
- management
+Check also the [slides](slides) (portuguese only).
-Installation
-============
+# Installation
-First, clone the code:
+## Clone
-::
+First, clone the code:
git clone https://git.fluxo.info/hydra
You can use the following to check the integrity of the latest release:
-::
-
/usr/bin/git -C hydra verify-commit HEAD
Note that `/usr/bin/git` is called to avoid any other `git` wrappers or aliases
* By symlinking `hydra`, `hydractl` and optionally `hydras` into your `~/bin` folder.
* By doing a system-wide install at `/usr/local` simply running
-::
-
- ./hydractl install
+ ./hydractl install
-Dependencies
-------------
+## Dependencies
Major direct upstreams:
-Management
-==========
+# Management
-Sets and supersets
-------------------
+## Sets and supersets
The Hydra Suite is flexible enough so you can use it to:
* Manage a single machine using `hydractl` command.
-* Manage a set or a subset of machines -- a *network* -- from the same organization using `hydra` command.
-* Manage a superset of machines -- *a constelation* -- comprised of one or more organizations using `hydras` command.
+* Manage a set or a subset of machines -- a *network* -- from the same
+ organization using `hydra` command.
+* Manage a superset of machines -- *a constelation* -- comprised of one or more
+ organizations using `hydras` command.
-Creating a new network
-----------------------
+## Creating a new network
-Use the following commands to create the needed repositories when starting a new network:
-
-::
+Use the following commands to create the needed repositories when starting a
+new network:
hydra example init ~/file/example
hydra example config domain example.org
-This makes `~/files/example` the base folder for all configuration of the network of machines called `example`.
+This makes `~/files/example` the base folder for all configuration of the
+network of machines called `example`.
-Managing an existing network
-----------------------------
+## Managing an existing network
If you have enough credentials (ssh pubkey set in the server), you can fetch
all the needed repositories and configurations to a local folder
`~/file/example` using simply the following command:
-::
-
hydra example init ~/file/example git@admin.example.org:
This will try to fetch a superproject from git@admin.example.org:example.git
--- /dev/null
+site_name: Hydra Suite
+
+theme:
+ name: readthedocs
+
+ logo: assets/logo.png
projects / hydra.git / commitdiff
