Update documentation

robertopreste · Aug 31, 2019 · aa28bb5 · aa28bb5
1 parent ce039bc
commit aa28bb5
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 65 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -3,11 +3,11 @@ Credits
 =======
 
 Development Lead
-----------------
+================
 
 * Roberto Preste <[email protected]>
 
 Contributors
-------------
+============
 
 None yet. Why not be the first?
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -8,10 +8,10 @@ helps, and credit will always be given.
 You can contribute in many ways:
 
 Types of Contributions
-----------------------
+======================
 
 Report Bugs
-~~~~~~~~~~~
+-----------
 
 Report bugs at https://github.com/robertopreste/apyhgnc/issues.
 
@@ -22,26 +22,26 @@ If you are reporting a bug, please include:
 * Detailed steps to reproduce the bug.
 
 Fix Bugs
-~~~~~~~~
+--------
 
 Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
 wanted" is open to whoever wants to implement it.
 
 Implement Features
-~~~~~~~~~~~~~~~~~~
+------------------
 
 Look through the GitHub issues for features. Anything tagged with "enhancement"
 and "help wanted" is open to whoever wants to implement it.
 
 Write Documentation
-~~~~~~~~~~~~~~~~~~~
+-------------------
 
 apyhgnc could always use more documentation, whether as part of the
 official apyhgnc docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
-~~~~~~~~~~~~~~~
+---------------
 
 The best way to send feedback is to file an issue at https://github.com/robertopreste/apyhgnc/issues.
 
@@ -53,7 +53,7 @@ If you are proposing a feature:
   are welcome :)
 
 Get Started!
-------------
+============
 
 Ready to contribute? Here's how to set up `apyhgnc` for local development.
 
@@ -92,7 +92,7 @@ Ready to contribute? Here's how to set up `apyhgnc` for local development.
 7. Submit a pull request through the GitHub website.
 
 Pull Request Guidelines
------------------------
+=======================
 
 Before you submit a pull request, check that it meets these guidelines:
 
@@ -105,15 +105,15 @@ Before you submit a pull request, check that it meets these guidelines:
    and make sure that the tests pass for all supported Python versions.
 
 Tips
-----
+====
 
 To run a subset of tests::
 
 $ py.test tests.test_apyhgnc
 
 
 Deploying
----------
+=========
 
 A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed (including an entry in HISTORY.rst).

diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,59 +3,67 @@ History
 =======
 
 0.1.0 (2019-04-10)
-------------------
+==================
 
 * First release.
 
 0.1.1 (2019-04-18)
-==================
+------------------
 
 * Add basic classes Info, Search and Fetch;
 * Add tests for Info, Search and Fetch.
 
 0.1.2 (2019-04-19)
-==================
+------------------
 
 * Refactor code and fix tests.
 
 0.1.3 (2019-04-21)
-==================
+------------------
 
 * Update tests;
 * Fix importing issue;
 * Update requirements.
 
 0.2.0 (2019-04-24)
-------------------
+==================
 
 * Setup proper async calls (``afetch`` and ``asearch``);
 * Update tests;
 * Fix documentation.
 
 0.2.1 (2019-04-29)
-==================
+------------------
 
 * Update tests to use latest HGNC data;
 * Add script to automatically create test data.
 
 0.2.2 (2019-05-04)
-==================
+------------------
 
 * Update tests to use latest HGNC data.
 
 0.2.3 (2019-05-08)
-==================
+------------------
 
 * Update documentation;
 * Update testfiles.
 
 0.2.4 (2019-05-09)
-==================
+------------------
 
 * Update testfiles and requirements.
 
 0.2.5 (2019-05-11)
-==================
+------------------
 
 * Update tests;
 * Better requirements handling.
+
+0.2.6 (2019-08-31)
+------------------
+
+* Update requirements;
+* Change docstrings to Google style;
+* Update documentation;
+* Update testfiles.
diff --git a/README.rst b/README.rst
@@ -36,8 +36,6 @@ apyhgnc
      :target: https://pyup.io/repos/github/robertopreste/apyhgnc/
      :alt: Python 3
 
-
-
 .. image:: https://pepy.tech/badge/apyhgnc
     :target: https://pepy.tech/project/apyhgnc
     :alt: Downloads
@@ -52,29 +50,40 @@ Async pythonic interface to HGNC.
 
 
 Features
---------
+========
 
-This Python package allows to retrieve entries from HGNC_ using synchronous or asynchronous calls.
+This Python package allows to retrieve entries from HGNC_ using 
+synchronous or asynchronous calls.
 
-* Return searchable fields and stored fields separately using the ``info()`` function (or the lower-level ``Info`` class).
-* Return all entries of interest limiting results only to hgnc_id, symbol and score fields using the ``search()`` function for synchronous calls or the ``asearch()`` function for asynchronous calls (or the lower-level ``Search`` class).
-* Return entries according to the given searchable fields, returning all the available stored fields using the ``fetch()`` function for synchronous calls or the ``afetch()`` function for asynchronous calls (or the lower-level ``Fetch`` class).
+* Return searchable fields and stored fields separately using the 
+``info()`` function (or the lower-level ``Info`` class).
+* Return all entries of interest limiting results only to hgnc_id, symbol 
+and score fields using the ``search()`` function for synchronous calls or 
+the ``asearch()`` function for asynchronous calls (or the lower-level 
+``Search`` class).
+* Return entries according to the given searchable fields, returning all 
+the available stored fields using the ``fetch()`` function for synchronous 
+calls or the ``afetch()`` function for asynchronous calls (or the 
+lower-level ``Fetch`` class).
 
-Please refer to the Usage_ section of the documentation for further information.
+Please refer to the Usage_ section of the documentation for further 
+information.
 
 Installation
-------------
+============
 
 **apyhgnc only supports Python 3**, and can be installed using pip::
 
     pip install apyhgnc
 
-Please refer to the Installation_ section of the documentation for further information.
+Please refer to the Installation_ section of the documentation for further 
+information.
 
 Credits
--------
+=======
 
-This package was created with Cookiecutter_ and the `cc-pypackage`_ project template.
+This package was created with Cookiecutter_ and the `cc-pypackage`_ project 
+template.
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`cc-pypackage`: https://github.com/robertopreste/cc-pypackage

diff --git a/docs/api.rst b/docs/api.rst
@@ -3,17 +3,20 @@ API
 ===
 
 Entry points
-------------
+============
 
-These functions are available after you ``import apyhgnc`` and should be used as the main entry points for apyhgnc. If you want more control, you can use the internal classes described below.
+These functions are available after you ``import apyhgnc`` and should be 
+used as the main entry points for apyhgnc. If you want more control, you 
+can use the internal classes described below.
 
 .. automodule:: apyhgnc.apyhgnc
    :members:
 
 Internal classes
-----------------
+================
 
-These are the internal classes used by apyhgnc. Use them if you want more control over the application.
+These are the internal classes used by apyhgnc. Use them if you want more 
+control over the application.
 
 .. automodule:: apyhgnc.classes
    :members:

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,8 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 
+              'sphinxcontrib.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,9 @@
-Welcome to apyhgnc's documentation!
-======================================
+.. include:: ../README.rst
 
-apyhgnc is a Python package that provides a synchronous interface to HGNC_.
+____ 
+
+Table Of Contents
+=================
 
 .. toctree::
    :maxdepth: 2
@@ -11,7 +13,6 @@ apyhgnc is a Python package that provides a synchronous interface to HGNC_.
    installation
    usage
    api
-   modules
    contributing
    authors
    history

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -5,15 +5,16 @@ Installation
 **PLEASE NOTE: apyhgnc only supports Python 3!**
 
 Stable release
---------------
+==============
 
 To install apyhgnc, run this command in your terminal:
 
 .. code-block:: console
 
     $ pip install apyhgnc
 
-This is the preferred method to install apyhgnc, as it will always install the most recent stable release.
+This is the preferred method to install apyhgnc, as it will always install 
+the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -23,7 +24,7 @@ you through the process.
 
 
 From sources
-------------
+============
 
 The sources for apyhgnc can be downloaded from the `Github repo`_.