prepare for release

README.md

@@ -21,99 +21,8 @@ pyDataverse is a Python module for [Dataverse](http://dataverse.org/). It uses t
 
 ## QUICKSTART
 
-**Requirements**
-
-* curl
-
-**Install**
-
-```shell
-virtualenv venv
-source venv/bin/activate
-pip install -r requirements.txt
-```
-
-**Connect to API**
-
-```python
-from pyDataverse.api import Api
-base_url = 'http://demo.dataverse.org'
-api = Api(base_url)
-```
-**Get dataverse**
-
-```python
-dv = 'ecastro'  # dataverse alias or id
-resp = api.get_dataverse(dv)
-print(resp.json())
-```
-
-**Get dataset**
-
-```python
-identifier = 'doi:10.5072/FK2/U6AEZM'  # doi of the dataset
-resp = api.get_dataset(identifier)
-```
-
-**Get datafile**
-
-```python
-datafile_id = '32'  # file id of the datafile
-resp = api.get_datafile(datafile_id)
-print(resp.content)
-```
+[See more](https://pydataverse.readthedocs.io/en/latest/index.html#quickstart).
 
 ## CONTRIBUTE
 
-In the spirit of free software, everyone is encouraged to help improve this project.
-
-Here are some ways you can contribute:
-
-- by reporting bugs
-- by suggesting new features
-- by translating to a new language
-- by writing or editing documentation
-- by writing code (**no pull request is too small**: fix typos in the user interface, add code comments, clean up inconsistent whitespace)
-- by refactoring code or adding new features (please get in touch with us before you do, so we can syncronize the efforts and prevent misunderstandings)
-- by [closing issues](https://github.com/AUSSDA/pyDataverse/issues)
-- by [reviewing pull requests](https://github.com/AUSSDA/pyDataverse/pulls)
-
-When you are ready, submit a [pull request](https://github.com/AUSSDA/pyDataverse).
-
-### Submitting an Issue
-
-We use the [GitHub issue tracker](https://github.com/AUSSDA/pyDataverse/issues) to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please try to provide a screenshot that demonstrates the problem.
-
-## DEVELOPMENT
-
-### Install
-
-```bash
-virtualenv venv
-source venv/bin/activate
-pip install -r requirements.txt
-```
-
-### Documentation
-
-**Create Sphinx Docs**
-
-Use Sphinx to create class and function documentation out of the doc-strings. You can call it via `tox`. This creates the created docs inside `docs/build`.
-
-```
-tox -e docs
-```
-
-**Create Coverage Reports**
-
-Run tests with coverage to create html and xml reports as an output. Again, call it via `tox`. This creates the created docs inside `docs/coverage_html/`.
-```shell
-tox -e coverage
-```
-
-**Run Coveralls**
-
-To use Coveralls on local development:
-```shell
-tox -e coveralls
-```
+[See more](https://pydataverse.readthedocs.io/en/latest/index.html#contributor-guide).

src/pyDataverse/docs/source/developer.rst

@@ -79,3 +79,32 @@ When you only want to run one test, e.g. the py36 test:
 .. code-block:: shell
 
     tox -e py36
+
+
+Documentation
+-----------------------------
+
+
+**Create Sphinx Docs**
+
+Use Sphinx to create class and function documentation out of the doc-strings. You can call it via `tox`. This creates the created docs inside `docs/build`.
+
+.. code-block:: shell
+
+    tox -e docs
+
+**Create Coverage Reports**
+
+Run tests with coverage to create html and xml reports as an output. Again, call it via `tox`. This creates the created docs inside `docs/coverage_html/`.
+
+.. code-block:: shell
+
+    tox -e coverage
+
+**Run Coveralls**
+
+To use Coveralls on local development:
+
+.. code-block:: shell
+
+    tox -e coveralls

src/pyDataverse/docs/source/index.rst

@@ -75,7 +75,7 @@ pyDataverse ecosystem and community.
    community/releases
 
 
-Developer Documentation
+Developer Guide
 -----------------------------
 
 If you are looking for information on a specific function, class, or method,
@@ -85,3 +85,29 @@ this part of the documentation is for you.
    :maxdepth: 2
 
    developer
+
+
+Contributor Guide
+-----------------------------
+
+In the spirit of free software, everyone is encouraged to help improve this project.
+
+Here are some ways you can contribute:
+
+- by reporting bugs
+- by suggesting new features
+- by translating to a new language
+- by writing or editing documentation
+- by writing code (**no pull request is too small**: fix typos in the user interface, add code comments, clean up inconsistent whitespace)
+- by refactoring code or adding new features (please get in touch with us before you do, so we can syncronize the efforts and prevent misunderstandings)
+- by `closing issues <https://github.com/AUSSDA/pyDataverse/issues>`_
+- by `reviewing pull requests <https://github.com/AUSSDA/pyDataverse/pulls>`_
+
+When you are ready, submit a `pull request <https://github.com/AUSSDA/pyDataverse>`_.
+
+**Submitting an Issue**
+
+We use the `GitHub issue tracker <https://github.com/AUSSDA/pyDataverse/issues>`_
+to track bugs and features. Before submitting a bug report or feature request,
+check to make sure it hasn't already been submitted. When submitting a bug report,
+please try to provide a screenshot that demonstrates the problem.