From 6cd56b573108b39ea1751dd06dd56c0e8f10a7c7 Mon Sep 17 00:00:00 2001 From: Florent Xicluna Date: Sat, 22 Dec 2012 00:28:12 +0100 Subject: Add Sphinx documentation --- docs/index.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/index.rst (limited to 'docs/index.rst') 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 + 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. -- cgit v1.2.1