Skip to content

Commit

Permalink
Add Sphinx documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cjolowicz committed Jan 28, 2020
1 parent 7a7ffd5 commit 1dd2d39
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
The Hypermodern Python Project
==============================

The example project for the
`Hypermodern Python <https://medium.com/@cjolowicz/hypermodern-python-d44485d9d769>`_
article series.
The command-line interface prints random facts to your console,
using the `Wikipedia API <https://en.wikipedia.org/api/rest_v1/#/>`_.


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

To install the Hypermodern Python project,
run this command in your terminal:

.. code-block:: console
$ pip install hypermodern-python
Usage
-----

Hypermodern Python's usage looks like:

.. code-block:: console
$ hypermodern-python [OPTIONS]
.. option:: -l <language>, --language <language>

The Wikipedia language edition,
as identified by its subdomain on
`wikipedia.org <https://www.wikipedia.org/>`_.
By default, the English Wikipedia is selected.

.. option:: --version

Display the version and exit.

.. option:: --help

Display a short usage message and exit.

0 comments on commit 1dd2d39

Please sign in to comment.