diff --git a/docs/builders.rst b/docs/builders.rst index b357a95..269b771 100644 --- a/docs/builders.rst +++ b/docs/builders.rst @@ -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 ` for how these are specified. diff --git a/docs/configuration.rst b/docs/configuration.rst index 695f1e9..784bf18 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -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() ` builder + at the end of the ``public`` build product. + See :ref:`Builders` for more information. + Environment =========== diff --git a/tzk/builders.py b/tzk/builders.py index 578ab5d..9c31d13 100644 --- a/tzk/builders.py +++ b/tzk/builders.py @@ -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