Now also add an index.rst.

This commit is contained in:
Dave Halter
2017-05-24 14:09:50 -04:00
parent d5c27b59be
commit e1ef9c086f
3 changed files with 33 additions and 2 deletions

View File

@@ -7,7 +7,7 @@ Usage
``load_grammar``. Grammars (with a custom tokenizer and custom parser trees)
can also be created by directly instantiating ``Grammar``. More information
about the resulting objects can be found in the :ref:`parser tree documentation
<plugin-api-classes>`.
<parser-tree>`.
The simplest way of using parso is without even loading a grammar:

31
docs/index.rst Normal file
View File

@@ -0,0 +1,31 @@
.. include global.rst
parso - A Python Parser Written in Python
=========================================
Release v\ |release|. (:doc:`Installation <docs/installation>`)
.. automodule:: parso
.. _toc:
Docs
----
.. toctree::
:maxdepth: 2
docs/installation
docs/usage
docs/parser-tree
docs/development
.. _resources:
Resources
---------
- `Source Code on Github <https://github.com/davidhalter/parso>`_
- `Travis Testing <https://travis-ci.org/davidhalter/parso>`_
- `Python Package Index <http://pypi.python.org/pypi/parso/>`_

View File

@@ -6,7 +6,7 @@ from parso._compatibility import unicode
def splitlines(string, keepends=False):
"""
r"""
A splitlines for Python code. In contrast to Python's ``str.splitlines``,
looks at form feeds and other special characters as normal text. Just
splits ``\n`` and ``\r\n``.