Documentation update

README.rst

@@ -14,31 +14,12 @@ can then use those Markdown files in your favorite static website generator.
 .. _BeerXML: http://www.beerxml.com/
 
 
-Installation
-------------
+Installation and Usage
+----------------------
 
-Synthale requires Python 3. Install Synthale from PyPi:
+Please visit `the documentation`_ for installation and usage instructions.
 
-::
-
-  pip3 install synthale
-
-
-Usage
------
-
-::
-
-  $ synthale --help
-  Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH
-
-  Generate markdown files from BeerXML files.
-
-  INPUT_PATH is either a directory containing XML files, or an individual
-  XML file. OUTPUT_PATH is the directory to write the markdown files to.
-
-  Options:
-  --help  Show this message and exit.
+.. _`the documentation`: https://synthale.readthedocs.io/en/latest/index.html
 
 
 License

docs-requirements.txt

@@ -1,2 +1,3 @@
 # Packages required to build the documentation
 sphinx-click
+sphinx_rtd_theme

docs/conf.py

@@ -83,7 +83,7 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/index.rst

@@ -16,8 +16,17 @@ can then use those Markdown files in your favorite static website generator.
    license
 
 
+Open Source
+-----------
+
+Synthale is free and open source! Get the source code at the
+`GitHub repository`_.
+
+.. _`GitHub repository`: https://github.com/shouptech/synthale
+
+
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

setup.py

@@ -13,8 +13,14 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+from os import path
+
 from setuptools import find_packages, setup
 
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
+    long_description = f.read()
+
 install_requires = [
     'Click',
     'pybeerxml>=1.0.6',
@@ -28,6 +34,8 @@ setup(
     author_email='mike@shoup.io',
     description='Synthale is a command line tool that convert BeerXML files '
         'into Markdown files.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
     package_dir={'': 'src'},
     packages=find_packages(where='src'),
     install_requires=install_requires,