docs: including more code samples

dev
Andy Meneely 2016-11-15 18:08:52 -05:00
parent b4068d2ac6
commit c1b8cf14ab
4 changed files with 27 additions and 4 deletions

View File

@ -20,7 +20,7 @@ Groups can be enabled and disabled in several ways:
* The :doc:`/dsl/enable_build` and :doc:`/dsl/disable_build` DSL methods can explicitly enable/disable a group. Again, you're back to commenting out the *enable_group* call, but that's easier than remembering what lines to comment out each time. * The :doc:`/dsl/enable_build` and :doc:`/dsl/disable_build` DSL methods can explicitly enable/disable a group. Again, you're back to commenting out the *enable_group* call, but that's easier than remembering what lines to comment out each time.
* When a ``Squib::Deck`` is initialized, the `environment variable <https://en.wikipedia.org/wiki/Environment_variable>`_ ``SQUIB_BUILD`` is consulted for a comma-separated string. These are converted to Ruby symbols and the corresponding groups are enabled. * When a ``Squib::Deck`` is initialized, the `environment variable <https://en.wikipedia.org/wiki/Environment_variable>`_ ``SQUIB_BUILD`` is consulted for a comma-separated string. These are converted to Ruby symbols and the corresponding groups are enabled.
Note that the environment variables are intended to change from run to run, from the command line (see above gist for examples in various OS's). Note that the environment variables are intended to change from run to run, from the command line.
.. note:: .. note::

View File

@ -60,3 +60,22 @@ The ``xlsx`` method also takes in a block that will be executed for each cell in
Examples Examples
-------- --------
To get the sample Excel files, go to `its source <https://github.com/andymeneely/squib/tree/dev/samples/data>`_
.. literalinclude:: ../../samples/data/_csv.rb
:language: ruby
:linenos:
Here's the sample.csv
.. literalinclude:: ../../samples/data/sample.csv
:language: csv
:linenos:
Here's the quantity_explosion.csv
.. literalinclude:: ../../samples/data/quantity_explosion.csv
:language: csv
:linenos:

View File

@ -289,6 +289,4 @@ angle
Examples Examples
-------- --------
.. raw:: html See :doc:`/text_feature`.
<script src="https://gist.github.com/andymeneely/52d7b8e332194946bc69.js"></script>

View File

@ -48,3 +48,9 @@ The ``xlsx`` method also takes in a block that will be executed for each cell in
Examples Examples
-------- --------
To get the sample Excel files, go to `its source <https://github.com/andymeneely/squib/tree/dev/samples/data>`_
.. literalinclude:: ../../samples/data/_excel.rb
:language: ruby
:linenos: