diff options
author | Florent Xicluna <florent.xicluna@gmail.com> | 2012-12-22 00:28:12 +0100 |
---|---|---|
committer | Florent Xicluna <florent.xicluna@gmail.com> | 2012-12-22 00:28:12 +0100 |
commit | 6cd56b573108b39ea1751dd06dd56c0e8f10a7c7 (patch) | |
tree | d11b8635723f838ac02ec48e1a55c5da5d72fecc /docs/index.rst | |
parent | 272571d14c2c07cf3008ab59782c554a1344ee3f (diff) | |
download | pep8-6cd56b573108b39ea1751dd06dd56c0e8f10a7c7.tar.gz |
Add Sphinx documentation
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..5e13ecd --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,52 @@ +.. pep8 documentation master file + +pep8's documentation +==================== + +*Python style guide checker* + +pep8 is a tool to check your Python code against some of the style +conventions in `PEP 8`_. + +.. _PEP 8: http://www.python.org/dev/peps/pep-0008/ + + +Features +-------- + +* Plugin architecture: Adding new checks is easy. + +* Parseable output: Jump to error location in your editor. + +* Small: Just one Python file, requires only stdlib. You can use just + the pep8.py file for this purpose. + +* Comes with a comprehensive test suite. + + +Contents: + +.. toctree:: + :maxdepth: 2 + + intro + API <api> + developer + +* Online documentation: http://pep8.readthedocs.org/ +* Source code and issue tracker: https://github.com/jcrocholl/pep8 + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + + +Credits +======= + +Created by Johann C. Rocholl. + +Maintained by Florent Xicluna. |