third_party/pep8/docs/index.rst

   1 .. pep8 documentation master file
   2
   3 pep8's documentation
   4 ====================
   5
   6 *Python style guide checker*
   7
   8 pep8 is a tool to check your Python code against some of the style
   9 conventions in `PEP 8`_.
  10
  11 .. _PEP 8: http://www.python.org/dev/peps/pep-0008/
  12
  13
  14 Contents:
  15
  16 .. toctree::
  17    :maxdepth: 2
  18
  19    intro
  20    advanced
  21    API <api>
  22    developer
  23
  24 * Online documentation: http://pep8.readthedocs.org/
  25 * Source code and issue tracker: https://github.com/jcrocholl/pep8
  26
  27
  28 Indices and tables
  29 ==================
  30
  31 * :ref:`genindex`
  32 * :ref:`search`
  33
  34
  35 Credits
  36 =======
  37
  38 Created by Johann C. Rocholl.
  39
  40 Maintained by Florent Xicluna and Ian Lee.
  41
  42
  43 .. _license:
  44
  45 License
  46 =======
  47
  48 The ``pep8`` library is provided under the terms and conditions of the
  49 Expat license::
  50
  51   # Permission is hereby granted, free of charge, to any person
  52   # obtaining a copy of this software and associated documentation files
  53   # (the "Software"), to deal in the Software without restriction,
  54   # including without limitation the rights to use, copy, modify, merge,
  55   # publish, distribute, sublicense, and/or sell copies of the Software,
  56   # and to permit persons to whom the Software is furnished to do so,
  57   # subject to the following conditions:
  58   #
  59   # The above copyright notice and this permission notice shall be
  60   # included in all copies or substantial portions of the Software.
  61   #
  62   # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  63   # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  64   # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  65   # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  66   # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  67   # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  68   # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  69   # SOFTWARE.