openstack/deb-python-pymysql
Code Issues Proposed changes

doc cleanup

Browse Source
This commit is contained in:
INADA Naoki
2016-05-24 17:05:44 +09:00
parent 0081da69c3
commit ef55b0237b
3 changed files with 4 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@@ -54,10 +54,6 @@ The last stable release is available on PyPI and can be installed with ``pip``::
$ pip install PyMySQL
For more details, please have a look at the
`installation instructions <http://tensorvision.readthedocs.io/en/latest/user/installation.html>`_
in the documentation.
Documentation
-------------
@@ -67,7 +63,6 @@ Documentation is available online: http://pymysql.readthedocs.io/
For support, please refer to the `StackOverflow
<http://stackoverflow.com/questions/tagged/pymysql>`_.
Example
-------

7
docs/source/user/development.rst
View File

@@ -8,15 +8,14 @@ You can help developing PyMySQL by `contributing on GitHub`_.
.. _contributing on GitHub: https://github.com/PyMySQL/PyMySQL
Building the documentation
==========================
--------------------------
Go to the ``docs`` directory and run ``make html``.
Test Suite
==========
-----------
If you would like to run the test suite, create database for test like this::
@@ -36,4 +35,4 @@ To run all the tests, execute the script ``runtests.py``::
A ``tox.ini`` file is also provided for conveniently running tests on multiple
Python versions::
$ tox
$ tox

13
docs/source/user/installation.rst
View File

@@ -8,17 +8,6 @@ The last stable release is available on PyPI and can be installed with ``pip``::
$ pip install PyMySQL
Alternatively (e.g. if ``pip`` is not available), a tarball can be downloaded
from GitHub and installed with Setuptools::
$ # X.X is the desired PyMySQL version (e.g. 0.5 or 0.6).
$ curl -L https://github.com/PyMySQL/PyMySQL/tarball/pymysql-X.X | tar xz
$ cd PyMySQL*
$ python setup.py install
$ # The folder PyMySQL* can be safely removed now.
However, you might have to install some requirements first.
Requirements
-------------
@@ -37,4 +26,4 @@ Requirements
.. _PyPy: http://pypy.org/
.. _IronPython: http://ironpython.net/
.. _MySQL: http://www.mysql.com/
.. _MariaDB: https://mariadb.org/
.. _MariaDB: https://mariadb.org/