Skip to content

Commit 9afaba8

Browse files
authored
docs: improve landing page (#57)
1 parent 9e28439 commit 9afaba8

1 file changed

Lines changed: 27 additions & 24 deletions

File tree

docs/index.rst

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ epidatpy
55
This package provides Python access to the `Delphi Epidata API
66
<https://cmu-delphi.github.io/delphi-epidata/>`_ published by the `Delphi
77
research group <https://delphi.cmu.edu>`_ at `Carnegie Mellon University
8-
<https://www.cmu.edu>`_. The package source code and bug tracker can be found
9-
`on GitHub <https://github.com/cmu-delphi/epidatpy>`_.
8+
<https://www.cmu.edu>`_.
109

11-
.. note :: **You should consider subscribing** to the `API mailing list
12-
<https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api>`_ to be
13-
notified of package updates, new data sources, corrections, and other
14-
updates.
10+
Useful links:
11+
- source code and bug tracker https://github.com/cmu-delphi/epidatpy
12+
- listing on PyPI https://pypi.org/project/epidatpy/
13+
- Epidata API key registration form https://api.delphi.cmu.edu/epidata/admin/registration_form
14+
- Epidata API key documentation https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html
1515

1616
See also the `CMU Delphi Terms of Use
1717
<https://delphi.cmu.edu/epidemic-signals/terms-of-use/>`_, noting that the data
@@ -20,13 +20,30 @@ is a research product and not warranted for a particular purpose.
2020
Installation
2121
===============
2222

23-
This package will soon be available on PyPI as `epidatpy
24-
<https://pypi.org/project/epidatpy/>`_. Meanwhile, it can be installed from
25-
GitHub:
23+
Install from PyPI using pip:
2624

2725
.. code-block:: sh
2826
29-
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
27+
pip install epidatpy
28+
29+
Documentation Contents
30+
======================
31+
32+
.. toctree::
33+
:maxdepth: 1
34+
35+
getting_started
36+
37+
signal_discovery
38+
39+
versioned_data
40+
41+
epidatpy
42+
43+
.. note :: **You should consider subscribing** to the `API mailing list
44+
<https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api>`_ to be
45+
notified of package updates, new data sources, corrections, and other
46+
updates.
3047
3148
API Keys
3249
===============
@@ -43,17 +60,3 @@ your environment, and adding ``.env`` to your ``.gitignore`` file.
4360

4461
Note that for the time being, the private endpoints (i.e. those prefixed with
4562
``pvt``) will require additional permissions (contact us for more information).
46-
47-
Documentation Contents
48-
======================
49-
50-
.. toctree::
51-
:maxdepth: 1
52-
53-
getting_started
54-
55-
signal_discovery
56-
57-
versioned_data
58-
59-
epidatpy

0 commit comments

Comments
 (0)