Skip to content

Commit

Permalink
Documentation moved.
Browse files Browse the repository at this point in the history
  • Loading branch information
coady committed Dec 21, 2017
1 parent ff08799 commit 122a7fe
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
9 changes: 4 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,15 @@ clean:
html:
make -C docs $@ SPHINXOPTS=-W SPHINXBUILD=sphinx-build
rst2$@.py README.rst docs/_build/README.$@
python -m examples.spatial > docs/_build/spatial.kml
python3 -m examples.spatial > docs/_build/spatial.kml

dist: html
python setup.py sdist
cd docs/_build/html && zip -r ../../../$@/docs.zip .
python3 setup.py sdist bdist_wheel

check:
python setup.py $@ -mrs
python3 setup.py $@ -mrs
flake8
python -m examples
python3 -m examples
pytest-2.7 tests/test_engine.py --cov=lupyne.engine --cov-fail-under=100
pytest --cov --cov-fail-under=100
pytest -vk example
14 changes: 6 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
About Lupyne
==================
.. image:: https://img.shields.io/pypi/v/lupyne.svg
:target: https://pypi.python.org/pypi/lupyne/
:target: https://pypi.org/project/lupyne/
.. image:: https://img.shields.io/pypi/pyversions/lupyne.svg
.. image:: https://img.shields.io/pypi/status/lupyne.svg
.. image:: https://api.shippable.com/projects/56059e3e1895ca4474182ec3/badge?branch=master
Expand Down Expand Up @@ -32,7 +32,7 @@ Advanced search features:
* Spellchecking.
* Near real-time indexing.

See `documentation`_ for example usage.
Read the `documentation`_.

Installation
==================
Expand All @@ -42,14 +42,13 @@ Installation

Dependencies
==================
* Python 2.7, 3.6
* PyLucene 6+ (installed separately)
* PyLucene >=6 (installed separately)
* six

Optional server extras

* CherryPy 10+
* clients 0.2+
* CherryPy >=10
* clients >=0.2

Tests
==================
Expand Down Expand Up @@ -79,7 +78,6 @@ dev
* Comparator iteration optimized
* Support for string based FieldCacheRangeFilters

.. _PyLucene is dormant: http://mail-archives.apache.org/mod_mbox/lucene-pylucene-dev/201506.mbox/%3calpine.OSX.2.01.1506010952020.53725@yuzu.local%3e
.. _PyLucene: http://lucene.apache.org/pylucene/
.. _CherryPy: http://cherrypy.org
.. _documentation: http://pythonhosted.org/lupyne/
.. _documentation: http://lupyne.surge.sh
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Indices and tables
* :ref:`modindex`
* :ref:`search`

.. _Lupyne: https://pypi.python.org/pypi/lupyne
.. _Lupyne: https://pypi.org/project/lupyne/
.. _PyLucene: http://lucene.apache.org/pylucene/
.. _RESTful: http://en.wikipedia.org/wiki/Representational_State_Transfer
.. _JSON: http://json.org/
Expand Down
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
packages=['lupyne', 'lupyne.engine'],
install_requires=['six'],
extras_require={'server': ['cherrypy>=10', 'clients>=0.2']},
python_requires='>=2.7',
tests_require=['pytest-cov'],
classifiers=[
'Development Status :: 6 - Mature',
Expand All @@ -23,6 +24,8 @@
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Topic :: Internet :: WWW/HTTP :: HTTP Servers',
'Topic :: Internet :: WWW/HTTP :: Indexing/Search',
Expand Down

0 comments on commit 122a7fe

Please sign in to comment.