updating docs

Author: chrishavlin

AUTHORS.rst renamed to AUTHORS.md

@@ -1,19 +1,15 @@
-.. highlight:: shell
 
-============
-Contributing
-============
+# Contributing
 
 Contributions are welcome, and they are greatly appreciated! Every little bit
 helps, and credit will always be given.
 
 You can contribute in many ways:
 
-Types of Contributions
-----------------------
+## Types of Contributions
+
+### Report Bugs
 
-Report Bugs
-~~~~~~~~~~~
 
 Report bugs at https://github.com/chrishavlin/yt_xarray/issues.
 
@@ -23,27 +19,23 @@ If you are reporting a bug, please include:
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
-Fix Bugs
-~~~~~~~~
+### 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
-~~~~~~~~~~~~~~~~~~
+### 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
-~~~~~~~~~~~~~~~~~~~
+### Write Documentation
 
 yt_xarray could always use more documentation, whether as part of the
 official yt_xarray docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
-Submit Feedback
-~~~~~~~~~~~~~~~
+### Submit Feedback
 
 The best way to send feedback is to file an issue at https://github.com/chrishavlin/yt_xarray/issues.
 
@@ -54,75 +46,91 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
-Get Started!
-------------
+## Get Started!
 
 Ready to contribute? Here's how to set up `yt_xarray` for local development.
 
 1. Fork the `yt_xarray` repo on GitHub.
-2. Clone your fork locally::
-
-    $ git clone git@github.com:your_name_here/yt_xarray.git
+2. Clone your fork locally:
+```
+$ git clone git@github.com:your_name_here/yt_xarray.git
+```
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+```
+$ mkvirtualenv yt_xarray
+$ cd yt_xarray/
+$ python -m pip install -e .
+$ python -m pip install -r requirements_dev.txt
+```
+4. (optional) Setup pre-commit
+```
+$ pre-commit install
+```
 
-    $ mkvirtualenv yt_xarray
-    $ cd yt_xarray/
-    $ python setup.py develop
+5. Create a branch for local development::
 
-4. Create a branch for local development::
+```
+$ git checkout -b name-of-your-bugfix-or-feature
+```
+Now you can make your changes locally.
 
-    $ git checkout -b name-of-your-bugfix-or-feature
+6. When you're done making changes, check that your changes pass the
+   tests:
 
-   Now you can make your changes locally.
+```
+$ pytest
+```
+To test multiple python versions, you can use `tox`:
 
-5. When you're done making changes, check that your changes pass flake8 and the
-   tests, including testing other Python versions with tox::
+```
+$ tox
+```
 
-    $ flake8 yt_xarray tests
-    $ python setup.py test or pytest
-    $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+7. Commit your changes and push your branch to GitHub:
 
-6. Commit your changes and push your branch to GitHub::
+```
+$ git add .
+$ git commit -m "Your detailed description of your changes."
+```
+If you've installed pre-commit, then pre-commit will run your changes through
+some style checks. It will try to fix files if needed. If it finds errors, you
+will need to re-add those files (after fixing it if pre-commit could not do so
+automatically) and then commit again.
 
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
+Now your branch is ready to push:
 
-7. Submit a pull request through the GitHub website.
+```
+$ git push origin name-of-your-bugfix-or-feature
+```
 
-Pull Request Guidelines
------------------------
+8. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
 2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/chrishavlin/yt_xarray/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+   your new functionality into a function with a docstring.
+3. The pull request should pass all automated tests.
 
-Tips
-----
+## Tips
 
-To run a subset of tests::
+To run a subset of tests:
 
 $ pytest tests.test_yt_xarray
 
 
-Deploying
----------
+## Deploying
 
 A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
-Then run::
+Make sure all your changes are committed (including an entry in HISTORY.md).
 
+```
 $ bump2version patch # possible: major / minor / patch
 $ git push
 $ git push --tags
-
-Travis will then deploy to PyPI if tests pass.
+```
+github will then push to PyPI if tests pass.

CONTRIBUTING.rst renamed to CONTRIBUTING.md

@@ -6,5 +6,6 @@ tox==3.14.0
 coverage==4.5.4
 Sphinx==1.8.5
 twine==1.14.0
+pre-commit
 
 pytest==6.2.4

HISTORY.rst renamed to HISTORY.md

@@ -4,13 +4,6 @@
 
 from setuptools import find_packages, setup
 
-with open("README.rst") as readme_file:
-    readme = readme_file.read()
-
-with open("HISTORY.rst") as history_file:
-    history = history_file.read()
-
-
 with open("requirements.txt") as reqs_file:
     requirements = reqs_file.read().strip().split("\n")
 
@@ -33,10 +26,10 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
     ],
-    description="interfaces between yt and xarray",
+    description="interface between yt and xarray",
     install_requires=requirements,
     license="MIT license",
-    long_description=readme + "\n\n" + history,
+    long_description="tools for connecting yt and xarray",
     include_package_data=True,
     keywords="yt_xarray",
     name="yt_xarray",