build_groups: rename to build instead of group

This commit is contained in:
Andy Meneely
2016-03-20 22:52:04 -04:00
parent c3f9e75d38
commit e55c450d16
6 changed files with 46 additions and 21 deletions
+7 -3
View File
@@ -1,4 +1,4 @@
group
build
=====
Establish a set of commands that can be enabled/disabled together to allow for customized builds. See :doc:`/build_groups` for ways to use this effectively.
@@ -6,10 +6,14 @@ Establish a set of commands that can be enabled/disabled together to allow for c
Required Arguments
------------------
.. note::
This is an argument, not an option like most DSL methods. See example below.
group
default: ``:all``
The name of the group. Convention is to use a Ruby symbol.
The name of the build group. Convention is to use a Ruby symbol.
&block
@@ -22,7 +26,7 @@ Examples
Use group to organize your Squib code into build groups::
Squib::Deck.new do
group :pnp do
build :pnp do
save_pdf
end
end
@@ -1,5 +1,5 @@
groups
======
build_groups
============
Returns the set of group names that have been enabled. See :doc:`/build_groups` for ways to use this effectively.
@@ -15,9 +15,9 @@ Examples
Use group to organize your Squib code into build groups::
Squib::Deck.new do
enable_group :pnp
group :pnp do
enable_build :pnp
build :pnp do
save_pdf
end
puts groups # outputs :all and :pnp
puts build_groups # outputs :all and :pnp
end
@@ -1,4 +1,4 @@
disable_group
disable_build
=============
Disable the given build group for the rest of the build. Thus, code within the corresponding :doc:`/dsl/group` block will not be executed. See :doc:`/build_groups` for ways to use this effectively.
@@ -7,10 +7,22 @@ Disable the given build group for the rest of the build. Thus, code within the c
Required Arguments
------------------
group
build_group_name
default: ``:all``
the name of the group to disable. Convention is to use a Ruby symbol.
.. note::
Examples
--------
Can be used to disable a group (even if it's enabled via command line)::
Squib::Deck.new do
disable_build :pnp
build :pnp do
save_pdf
end
end
@@ -1,5 +1,5 @@
enable_group
=============
enable_build
============
Enable the given build group for the rest of the build. Thus, code within the corresponding :doc:`/dsl/group` block will be executed. See :doc:`/build_groups` for ways to use this effectively.
@@ -7,10 +7,19 @@ Enable the given build group for the rest of the build. Thus, code within the co
Required Arguments
------------------
group
build_group_name
the name of the group to enable. Convention is to use a Ruby symbol.
Examples
--------
Can be used to disable a group (even if it's enabled via command line)::
Squib::Deck.new do
disable_build :pnp
build :pnp do
save_pdf
end
end