From 5759be87ab603cab6c786a6313b6dbc5993fcd9d Mon Sep 17 00:00:00 2001 From: Sean Roberts Date: Wed, 10 Jun 2015 12:24:45 -0700 Subject: [PATCH] Update the docs directory State machine bits removed as they are moving to the akanda repo Aslo fix bad URL in root readme Partially Implements: blueprint liberty-doc-updates Change-Id: I35cd688850fdd007bb9f0fb27759f6081e64d160 --- README.md | 2 +- doc/Makefile | 153 ----------------------------------- doc/source/index.rst | 22 ----- doc/source/state_machine.dot | 57 ------------- doc/source/state_machine.rst | 43 ---------- {doc => docs}/source/conf.py | 0 docs/source/index.rst | 4 + tox.ini | 2 +- 8 files changed, 6 insertions(+), 277 deletions(-) delete mode 100644 doc/Makefile delete mode 100644 doc/source/index.rst delete mode 100644 doc/source/state_machine.dot delete mode 100644 doc/source/state_machine.rst rename {doc => docs}/source/conf.py (100%) create mode 100644 docs/source/index.rst diff --git a/README.md b/README.md index 03dd3cfe..273f1608 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Akanda Rug -*Part of the [Akanda Project](https://github.com/dreamhost/akanda).* +*Part of the [Akanda Project](https://github.com/stackforge/akanda).* **ties the room together** diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index a18a580a..00000000 --- a/doc/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -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) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.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 ' where 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/AkandaRUG.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AkandaRUG.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/AkandaRUG" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AkandaRUG" - @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." diff --git a/doc/source/index.rst b/doc/source/index.rst deleted file mode 100644 index 293336ab..00000000 --- a/doc/source/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. Akanda RUG documentation master file, created by - sphinx-quickstart on Mon Mar 17 14:59:20 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Akanda RUG's documentation! -====================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - state_machine - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/source/state_machine.dot b/doc/source/state_machine.dot deleted file mode 100644 index 4c037e21..00000000 --- a/doc/source/state_machine.dot +++ /dev/null @@ -1,57 +0,0 @@ -digraph rug { - // rankdir=LR; - - node [shape = rectangle]; - START; - - // These nodes enter and exit the state machine. - - node [shape = doublecircle]; - EXIT; - CALC_ACTION; - - node [shape = circle]; - - START -> CALC_ACTION; - - CALC_ACTION -> ALIVE [ label = "ACT>[CRUP],vm:[UC]" ]; - CALC_ACTION -> CREATE_VM [ label = "ACT>[CRUP],vm:D" ]; - CALC_ACTION -> CHECK_BOOT [ label = "ACT>[CRUP],vm:B" ]; - CALC_ACTION -> REBUILD_VM [ label = "ACT:E" ]; - CALC_ACTION -> STOP_VM [ label = "ACT>D or vm:G" ]; - CALC_ACTION -> CLEAR_ERROR [ label = "vm:E" ]; - - ALIVE -> CREATE_VM [ label = "vm>D" ]; - ALIVE -> CONFIG [ label = "ACT:[CU],vm:[UC]" ]; - ALIVE -> STATS [ label = "ACT:R,vm:C" ]; - ALIVE -> CALC_ACTION [ label = "ACT:P,vm>[UC]" ]; - ALIVE -> STOP_VM [ label = "vm:G" ]; - - CREATE_VM -> CHECK_BOOT [ label = "ACT:[CRUDP],vm:[DBUCR]" ]; - CREATE_VM -> STOP_VM [ label = "vm:G" ]; - CREATE_VM -> CALC_ACTION [ label = "vm:E" ]; - CREATE_VM -> CREATE_VM [ label = "vm:D" ]; - - CHECK_BOOT -> CONFIG [ label = "vm>U" ]; - CHECK_BOOT -> CALC_ACTION [ label = "vm:[BCR]" ]; - CHECK_BOOT -> STOP_VM [ label = "vm:[DG]" ]; - - CONFIG -> STATS [ label = "ACT:R,vm>C" ]; - CONFIG -> CALC_ACTION [ label = "ACT>P,vm>C" ]; - CONFIG -> REPLUG_VM [ label = "vm>[H]" ]; - CONFIG -> STOP_VM [ label = "vm>[RDG]" ]; - - REPLUG_VM -> CONFIG [ label = "vm>[H]" ]; - REPLUG_VM -> STOP_VM [ label = "vm>[R]" ]; - - STATS -> CALC_ACTION [ label = "ACT>P" ]; - - CLEAR_ERROR -> CALC_ACTION [ label = "no pause before next action" ]; - - REBUILD_VM -> REBUILD_VM [ label = "vm!=[DG]" ]; - REBUILD_VM -> CREATE_VM [ label = "ACT:E,vm:D" ]; - - STOP_VM -> CREATE_VM [ label = "ACT:E or vm>D" ]; - STOP_VM -> EXIT [ label = "ACT:D,vm>D or vm:G" ]; - -} diff --git a/doc/source/state_machine.rst b/doc/source/state_machine.rst deleted file mode 100644 index f87baf0f..00000000 --- a/doc/source/state_machine.rst +++ /dev/null @@ -1,43 +0,0 @@ -====================== - Worker State Machine -====================== - -.. graphviz:: state_machine.dot - -States -====== - -:CALC_ACTION: Coalesces the pending actions from the queue inside the state machine. -:ALIVE: Checks whether the instance is alive. -:CLEAR_ERROR: Clear the error status before attempting any further operation. -:STATS: Reads traffic data from the router. -:CREATE_VM: Makes a new VM instance. -:CHECKBOOT: Check if a new VM instance has been booted and initially configured. -:CONFIG: Configures the VM and its services. -:REPLUG_VM: Attempts to replug the VM with a new network (or remove an - unplugged one). -:STOP_VM: Terminates a running VM. -:EXIT: Processing stops. - -ACT(ion) Variable -================= - -:Create: Create router was requested. -:Read: Read router traffic stats. -:Update: Update router configuration. -:Delete: Delete router. -:Poll: Poll router alive status. -:rEbuild: Recreate a router from scratch. - -vm Variable -=========== - -:Down: VM is known to be down. -:Booting: VM is booting. -:Up: VM is known to be up (pingable). -:Configured: VM is known to be configured. -:Restart Needed: VM needs to be rebooted. -:Hotplug Needed: VM needs to be replugged. -:Gone: The router definition has been removed from neutron. -:Error: The router has been rebooted too many times, or has had some - other error. diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..0756d5b8 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,4 @@ +Akanda Docs +=========== + +Find the docs in the `Akanda repository `_ diff --git a/tox.ini b/tox.ini index 70f7bf12..9794d676 100644 --- a/tox.ini +++ b/tox.ini @@ -21,7 +21,7 @@ commands = {[testenv:style]commands} [testenv:doc] deps = Sphinx -commands = sphinx-build doc/source doc/build +commands = sphinx-build docs/source docs/build [testenv:cover] setenv = NOSE_WITH_COVERAGE=1