Permalink
Browse files

stub out the docs

  • Loading branch information...
1 parent 24ae8d1 commit 65c9427047fcc037d0973a8a78e58ab9fcf02cd4 @tswicegood tswicegood committed Feb 10, 2010
View
@@ -2,3 +2,4 @@
MANIFEST
dist/*
build/
+docs/_build/*
@@ -3,22 +3,28 @@ d51.fabric.tasks.mosso
Fabric tasks for handling basic management tasks on Mosso/Rackspace Cloud Servers
+
Requirements
------------
-This has been built to be used with the 1.0a version of the [Fabric fork][]
-maintained by [Travis Swicegood][]. It might be usable with other versions of
-Fabric, but your mileage may vary.
+This has been built to be used with the 1.0a version of the `Fabric
+fork <http://github.com/tswicegood/fabric>`_ maintained by `Travis
+Swicegood <http://www.travisswicegood.com>`_. It might be usable with other
+versions of Fabric, but your mileage may vary.
Installation
------------
Create a clone of the repository:
+::
+
git clone git://github.com/domain51/d51.fabric.tasks.mosso.git
Then, inside that directory you can install it using either the `setup.py` file
directly, or via Fabric:
+::
+
prompt> python setup.py install
... or ...
prompt> fab install
@@ -27,51 +33,39 @@ Usage
-----
You can import the individual tasks into your current fabfile:
+
+::
+
from d51.fabric.tasks.mosso import *
Or, you can import the module and execute the tasks that way:
+::
+
from d51.fabric.tasks import mosso
### Providing Credentials
You must provide the tasks with a way to authenticate with Mosso. To do this,
you need your username and your API key. You can provide these via the
`mosso.user` and `mosso.key` tasks at runtime:
+::
+
prompt> fab mosso.user:some_user mosso.key:some_generated_api_key ... rest of tasks ...
Or, you can specify them as `env` variables inside your fabfile.
+::
+
from fabric.api import env
env.mosso_user = "some_user"
env.mosso_key = "some_generated_api_key"
-Tasks
------
-* `mosso.flavors.detail`
-* `mosso.flavors.detail_output`
-* `mosso.flavors.list`
-* `mosso.flavors.list_output`
-* `mosso.images.detail`
-* `mosso.images.detail_output`
-* `mosso.images.get_server_api`
-* `mosso.images.list`
-* `mosso.images.list_output`
-* `mosso.ips.get_server_api`
-* `mosso.ips.list`
-* `mosso.ips.share`
-* `mosso.ips.unshare`
-* `mosso.key`
-* `mosso.servers.create`
-* `mosso.servers.delete`
-* `mosso.servers.detail`
-* `mosso.servers.detail_output`
-* `mosso.servers.get_server_api`
-* `mosso.servers.list`
-* `mosso.servers.list_output`
-* `mosso.servers.update`
-* `mosso.user`
-
-[Fabric fork]: http://github.com/tswicegood/fabric
-[Travis Swicegood]: http://www.travisswicegood/
+
+Full Documentation
+------------------
+Full documentation is available in the `docs/` directory and is buildable
+using `Sphinx <http://sphinx.pocoo.org/>`_.
+
+
View
@@ -0,0 +1,89 @@
+# 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) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @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."
+
+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/d51fabrictasksubuntu.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/d51fabrictasksubuntu.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+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."
Oops, something went wrong. Retry.

0 comments on commit 65c9427

Please sign in to comment.