doc tweaks
This commit is contained in:
		| @@ -4,7 +4,8 @@ Builders | ||||
|  | ||||
| .. currentmodule:: tzk.builders | ||||
|  | ||||
| *Builders* are small executable chunks that together can be linked into a useful build process. | ||||
| *Builders* are small executable chunks | ||||
| that can be linked together to form a useful build process. | ||||
| Products are built by applying builders in sequence. | ||||
| Please see the existing ``products`` dictionary and associated comments | ||||
| in the :ref:`config file <Configuring tzk>` for how these are specified. | ||||
|   | ||||
| @@ -37,13 +37,22 @@ is difficult and not all that useful, | ||||
| so the ``tzk commit`` command is made available | ||||
| to quickly stage, commit, and (if you wish) push all changes in the repository in one go. | ||||
|  | ||||
| To enable pushes, | ||||
| If you want to push your changes to some remote location, | ||||
| such as a GitHub repository, | ||||
| add a new Git remote (e.g., ``git remote add origin https://github.com/you/YourRepository``) | ||||
| and set the ``commit_remote`` option in your tzk config to the remote name | ||||
| (here, ``origin``). | ||||
| You can selectively skip pushing for a particular commit | ||||
| with the ``--local`` switch to ``tzk commit``. | ||||
|  | ||||
| .. note:: | ||||
|    If you want to push a wiki that contains only some of your content | ||||
|    to GitHub in a form that others can browse, | ||||
|    don't try to set it up here -- | ||||
|    use a :func:`publish_wiki_to_github() <tzk.builders.publish_wiki_to_github>` builder | ||||
|    at the end of the ``public`` build product. | ||||
|    See :ref:`Builders` for more information. | ||||
|  | ||||
|  | ||||
| Environment | ||||
| =========== | ||||
|   | ||||
| @@ -30,7 +30,7 @@ def tzk_builder(func): | ||||
|     Decorator which makes a function lazy-evaluable: that is, when it's | ||||
|     initially called, it returns a zero-argument lambda with the arguments | ||||
|     initially passed wrapped up in it. Calling that lambda has the effect | ||||
|     of executing the function. | ||||
|     of executing the builder. | ||||
|  | ||||
|     We use this in TZK to allow the user to use function calls in her config | ||||
|     to define the build steps, while not requiring her to write a bunch of | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Soren I. Bjornstad
					Soren I. Bjornstad