Michal Dvorak avatar Michal Dvorak committed b25b96b

Improved formatting of readme

Comments (0)

Files changed (2)

 Setup Buildout Recipe
 =====================
 
-Runs the setup.py in all specified directories, using custom interpreter, e.g. the one generated by zc.buildout.egg
+Runs the ``setup.py`` in all specified directories, using custom interpreter, e.g. the one generated by zc.buildout.egg
 recipe. Its intended be used to run any commands that require libraries (eggs) from buildout.
-Any additional command line arguments are passed to the setup.py. Setup is always run in working directory where it
+Any additional command line arguments are passed to the ``setup.py``. Setup is always run in working directory where it
 resides.
 
 Parameters
-use-interpreter - Name of python interpreter to use.
-develop - List of directories, where setup.py files reside. Typically ${buildout:develop} to list all developed apps.
-command - Command line argument for the setup.py. Optional.
 
-Typical buildout.cfg snippet
+* use-interpreter - Name of python interpreter to use.
+* develop - List of directories, where ``setup.py`` files reside. Typically ``${buildout:develop}`` to list all developed apps.
+* command - Command line argument for the ``setup.py``. Optional.
 
-[python]
-recipe = zc.recipe.egg
-interpreter = python
-eggs = ${buildout:eggs}
+Typical buildout.cfg snippet::
 
-[test]
-recipe = setup-recipe
-use-interpreter = ${python:interpreter}
-develop = ${buildout:develop}
-command = test
+    [python]
+    recipe = zc.recipe.egg
+    interpreter = python
+    eggs = ${buildout:eggs}
 
-Running `./bin/test` will then run `./bin/python setup.py test` for every developed project.
+    [test]
+    recipe = setup-recipe
+    use-interpreter = ${python:interpreter}
+    develop = ${buildout:develop}
+    command = test
+
+Running ``./bin/test`` will then run ``./bin/python setup.py test`` for every developed project.

setup_recipe/__init__.py

 
 class Recipe(object):
     """
-    Buildout recipe that writes out script into bin directory. Script then runs setup.py
+    Buildout recipe that writes out script into bin directory. Script then runs `setup.py`
     in all configured directories using specified python interpreter.
 
     Supported options:
-    use-interpreter - Name of python interpreter to use.
-    develop - List of directories, where setup.py files reside. Typically ${buildout:develop} to list all developed apps.
-    command - Command line argument for the setup.py. Optional.
+    * use-interpreter - Name of python interpreter to use.
+    * develop - List of directories, where `setup.py` files reside. Typically `${buildout:develop}` to list all developed apps.
+    * command - Command line argument for the `setup.py`. Optional.
     """
 
     def __init__(self, buildout, name, options):
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.