Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
siddhantgoel committed Jun 20, 2017
1 parent 132d3fb commit 5b7456b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/_templates/usefullinks.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<h3>Useful links</h3>

<ul>
<li><a href="http://github.com/siddhantgoel/streaming-form-data">Github</a></li>
<li><a href="http://github.com/siddhantgoel/streaming-form-data/issues">Issues @ Github</a></li>
<li><a href="http://cython.org">Cython</a></li>
</ul>
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_sidebars = {
'index': ['localtoc.html', 'relations.html', 'sourcelink.html',
'usefullinks.html', 'searchbox.html']
}


# -- Options for HTMLHelp output ------------------------------------------

Expand Down
14 changes: 14 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ Please note, that this library has only been tested with Python 3 (specifically,
versions 3.3, 3.4, 3.5, and 3.6). Python 2.7 is not supported yet, but pull
requests are always welcome.

Installation
------------

The core parser is written in :code:`Cython`, which is a superset of Python but
compiles the input down to a C extension which can then be imported in normal
Python code.

The compiled C parser code is included in the PyPI package, hence the
installation requires a working C compiler.

.. code-block:: bash
$ pip install streaming_form_data
Usage
-----

Expand Down

0 comments on commit 5b7456b

Please sign in to comment.