Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Started in with Sphinx in a big way. Totally not done yet but groundw…
…ork here.
- Loading branch information
1 parent
6a22869
commit 88badcf
Showing
36 changed files
with
450 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,3 +14,4 @@ Fabric.egg-info | |
release | ||
*.png | ||
.coverage | ||
docs/_* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,16 @@ | ||
FABRIC README. | ||
Fabric is a Python library and command-line tool designed to streamline | ||
deploying applications or performing system administration tasks via the SSH | ||
protocol. It provides tools for running arbitrary shell commands (either as a | ||
normal login user, or via ``sudo``), uploading and downloading files, and so | ||
forth. | ||
|
||
Fabric is a simple pythonic remote deployment tool. | ||
Typical use involves defining a "fabfile" (a Python module) containing one or | ||
more functions or tasks which may then be executed by the ``fab`` command-line | ||
tool. Fabric provides extra functionality related to this mode of use, such as | ||
prompting for user input, ensuring certain variables are present in order for | ||
tasks to run, and specifying which host or hosts a specific task connects to by | ||
default. | ||
|
||
It is designed to upload files to, and run shell commands on, a number of | ||
servers in parallel or serially. These commands are grouped in tasks (regular | ||
python functions) and specified in a 'fabfile.' | ||
|
||
This is called remote automation, and the primary use case is deploying | ||
applications to multiple similar hosts. | ||
|
||
Although it is easier to automate when the target hosts are similar, it is not | ||
a requirement and Fabric has features for working with heterogeneous hosts as | ||
well. | ||
|
||
Once installed, you can run `fab help` to learn more about how to use Fabric. | ||
|
||
If you want to make changes to the Fabric source code, then please see the | ||
guide lines located here: http://www.nongnu.org/fab/hacking.html | ||
Fabric may also be used as a standalone library, so that other Python programs | ||
needing a simple API on top of SSH or SCP may import and utilize specific | ||
pieces of functionality. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = sphinx-build | ||
PAPER = | ||
|
||
# Internal variables. | ||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||
PAPEROPT_letter = -D latex_paper_size=letter | ||
ALLSPHINXOPTS = -d _build/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 _build/* | ||
|
||
html: | ||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html | ||
@echo | ||
@echo "Build finished. The HTML pages are in _build/html." | ||
|
||
dirhtml: | ||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml | ||
@echo | ||
@echo "Build finished. The HTML pages are in _build/dirhtml." | ||
|
||
pickle: | ||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle | ||
@echo | ||
@echo "Build finished; now you can process the pickle files." | ||
|
||
json: | ||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json | ||
@echo | ||
@echo "Build finished; now you can process the JSON files." | ||
|
||
htmlhelp: | ||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp | ||
@echo | ||
@echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
".hhp project file in _build/htmlhelp." | ||
|
||
qthelp: | ||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp | ||
@echo | ||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
".qhcp project file in _build/qthelp, like this:" | ||
@echo "# qcollectiongenerator _build/qthelp/Fabric.qhcp" | ||
@echo "To view the help file:" | ||
@echo "# assistant -collectionFile _build/qthelp/Fabric.qhc" | ||
|
||
latex: | ||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex | ||
@echo | ||
@echo "Build finished; the LaTeX files are in _build/latex." | ||
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ | ||
"run these through (pdf)latex." | ||
|
||
changes: | ||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes | ||
@echo | ||
@echo "The overview file is in _build/changes." | ||
|
||
linkcheck: | ||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck | ||
@echo | ||
@echo "Link check complete; look for any errors in the above output " \ | ||
"or in _build/linkcheck/output.txt." | ||
|
||
doctest: | ||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest | ||
@echo "Testing of doctests in the sources finished, look at the " \ | ||
"results in _build/doctest/output.txt." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
=========== | ||
Lol the API | ||
=========== | ||
|
||
.. automodule:: fabric.main | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Fabric documentation build configuration file, created by | ||
# sphinx-quickstart on Sat Apr 25 14:53:36 2009. | ||
# | ||
# 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, 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.append(os.path.abspath('.')) | ||
|
||
# -- General configuration ----------------------------------------------------- | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be extensions | ||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
extensions = ['sphinx.ext.autodoc'] | ||
|
||
# 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' | ||
|
||
# The master toctree document. | ||
master_doc = 'index' | ||
|
||
# General information about the project. | ||
project = u'Fabric' | ||
copyright = u'2009, Christian Vest Hansen and Jeffrey E. Forcier' | ||
|
||
# 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.9' | ||
# The full version, including alpha/beta/rc tags. | ||
release = '0.9a' | ||
|
||
# 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 documents that shouldn't be included in the build. | ||
#unused_docs = [] | ||
|
||
# List of directories, relative to source directory, that shouldn't be searched | ||
# for source files. | ||
exclude_trees = ['_build'] | ||
|
||
# The reST default role (used for this markup: `text`) to use for all documents. | ||
default_role = 'obj' | ||
|
||
# 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 = [] | ||
|
||
|
||
# -- Options for HTML output --------------------------------------------------- | ||
|
||
# The theme to use for HTML and HTML Help pages. Major themes that come with | ||
# Sphinx are currently 'default' and 'sphinxdoc'. | ||
html_theme = 'default' | ||
|
||
# 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 = None | ||
|
||
# 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'] | ||
|
||
# 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_use_modindex = 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, 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 = '' | ||
|
||
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | ||
#html_file_suffix = '' | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = 'Fabricdoc' | ||
|
||
|
||
# -- Options for LaTeX output -------------------------------------------------- | ||
|
||
# The paper size ('letter' or 'a4'). | ||
#latex_paper_size = 'letter' | ||
|
||
# The font size ('10pt', '11pt' or '12pt'). | ||
#latex_font_size = '10pt' | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, author, documentclass [howto/manual]). | ||
latex_documents = [ | ||
('index', 'Fabric.tex', u'Fabric Documentation', | ||
u'Jeff Forcier', '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 | ||
|
||
# Additional stuff for the LaTeX preamble. | ||
#latex_preamble = '' | ||
|
||
# Documents to append as an appendix to all manuals. | ||
#latex_appendices = [] | ||
|
||
# If false, no module index is generated. | ||
#latex_use_modindex = True |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
=========== | ||
Development | ||
=========== | ||
|
||
lol |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
========= | ||
Downloads | ||
========= | ||
|
||
This page contains a list of all current and prior Fabric releases, as well as | ||
download links for most recent releases. | ||
|
||
For installation information, please see the :doc:`installation` page. | ||
|
||
For information on obtaining the source code / development version of Fabric, | ||
please see the :doc:`development` page. | ||
|
||
|
||
Latest stable release | ||
--------------------- | ||
|
||
The latest stable release of Fabric is 0.9a. | ||
|
||
You may download a gzipped tarfile archive :download:`here <../tgz/fabric-0.9a.tgz>`. | ||
|
||
Previous stable releases | ||
------------------------ | ||
|
||
The following list contains all Fabric releases created since this | ||
documentation system was generated (and thus represented in the | ||
various "New in version *X*" or "Changed in version *Y*" notes): | ||
|
||
* None yet! | ||
|
||
Older releases | ||
-------------- | ||
|
||
Prior to being rewritten and moving to the current documentation setup, Fabric | ||
went through a number of older releases, documented here for posterity: | ||
|
||
* 0.1.1 | ||
* 0.1.0 | ||
* 0.0.9 | ||
* 0.0.8 | ||
* 0.0.7 | ||
* 0.0.6 | ||
* 0.0.5 | ||
* 0.0.4 | ||
* 0.0.3 | ||
* 0.0.2 | ||
* 0.0.1 |
Oops, something went wrong.