Commits

Jan-Jaap Driessen  committed 222f141

update docs about hiding source files of compiled resources

  • Participants
  • Parent commits b49a440
  • Branches wosc-compilers

Comments (0)

Files changed (2)

File doc/compilers.rst

          requires the ``cssmin`` package.
 :jsmin: :pypi:`jsmin`, A Python port of Douglas Crockford's ``jsmin``,
         requires the ``jsmin`` package.
+:closure: :pypi:`closure`, A Python wrapper around the `Google Closure
+Compiler`_.
 
+.. _`Google Closure Compiler`: https://developers.google.com/closure/compiler/
 
 
+Hiding source files
+-------------------
+
+You can prevent the Fanstatic publisher from serving the source files
+in by using the :doc:`ignores <configuration>` configuration option.
+
 Writing compilers
 -----------------
 
 
   entry_points={
       'fanstatic.compilers': [
-          'coffee = fanstatic.compiler:COFFE_COMPILER',
+          'coffee = fanstatic.compiler:COFFEE_COMPILER',
           ],
       'fanstatic.minifiers': [
           'jsmin = fanstatic.compiler:JSMIN_MINIFIER',

File doc/configuration.rst

 available. If no minified version is available, the default resource
 will be served.
 
+ignores
+-------
+
+You can prevent the Fanstatic publisher from publishing certain files and
+directories by using the ``ignores`` option.  You can leave the source files
+of your graphics and client side logic near the result files without worrying
+about Fanstatic 'leaking' this information.  The ``ignores`` option accepts a
+list of glob patterns.
+
 rollup
 ------
 
 
 Bundling of resources minimizes HTTP requests from the client by finding
 efficient bundles of resources. In order to configure bundling of resources,
-set the ``bundle`` argument to True. 
+set the ``bundle`` argument to True.
 
 .. [#well] Well, for 10 years into the future at least.