updated cheat sheet, Makefile

Author: smurfix

CHEATSHEET.rst

@@ -1,62 +1,25 @@
-Finishing setting up your project
-=================================
-
-Thanks for using cookiecutter-trio! This is your project now; you can
-customize it however you like. Here's some reminders of things you
-might want to do to get started:
-
-* Check this into source control (``git init .; git add .; git
-  commit -m "Initial commit"``)
-
-* Add a CODE_OF_CONDUCT.md
-
-* Add a CONTRIBUTING.md
-
-* Search the source tree for COOKIECUTTER-TRIO-TODO to find other
-  places to fill in.
-* Enable `Read the Docs <https://readthedocs.org>`__. (Note: this
-  project contains a ``.readthedocs.yml`` file that should be enough
-  to get things working.)
-
-* Set up continuous integration: Currently, this project is set up to
-  test on Linux and MacOS using Travis, on Windows using Appveyor, and
-  to test on PyPy.
-
-  If that's what you want, then go to Travis and Appveyor and enable
-  testing for your repo.
-
-  If that's not what you want, then you can trim the list by modifying
-  (or deleting) ``.travis.yml``, ``.appveyor.yml``, ``ci/travis.sh``.
-
-* Enable `Codecov <https://codecov.io>`__ for your repo.
-
-* File bugs or pull requests on `cookiecutter-trio
-  <https://github.com/python-trio/cookiecutter-trio>`__ reporting any
-  problems or awkwardness you ran into (no matter how small!)
-
-* Delete this checklist once it's no longer useful
-
-
 Tips
 ====
 
 To run tests
 ------------
 
-* Install requirements: ``pip install -r test-requirements.txt``
+* Install requirements: ``pip install -r ci/test-requirements.txt``
   (possibly in a virtualenv)
 
-* Actually run the tests: ``pytest trio_asyncio``
+* Actually run the tests: ``PYTHONPATH=. pytest-3 tests``
 
 
 To run yapf
 -----------
 
-* Show what changes yapf wants to make: ``yapf -rpd setup.py
-  trio_asyncio``
+* Show what changes yapf wants to make:
+  ``yapf3 -rpd setup.py trio_asyncio tests``
 
-* Apply all changes directly to the source tree: ``yapf -rpi setup.py
-  trio_asyncio``
+* Apply all changes directly to the source tree:
+  ``yapf -rpi setup.py trio_asyncio tests``
+
+* Find semantic problems: ``flake8 setup.py trio_asyncio tests``
 
 
 To make a release
@@ -72,10 +35,7 @@ To make a release
 
 * Double-check it all works, docs build, etc.
 
-* Build your sdist and wheel: ``python setup.py sdist bdist_wheel``
-
-* Upload to PyPI: ``twine upload dist/*``
-
-* Use ``git tag`` to tag your version.
+* Upload to PyPI: ``make upload``
 
 * Don't forget to ``git push --tags``.
+

Makefile

@@ -33,7 +33,7 @@ SPHINXBUILDDIR ?= $(BUILD_DIR)/sphinx/html
 ALLSPHINXOPTS ?= -d $(BUILD_DIR)/sphinx/doctrees $(SPHINXOPTS) docs
 
 doc:
-	sphinx-build -a $(INPUT_DIR) build
+	sphinx3-build -a $(INPUT_DIR) $(BUILD_DIR)
 
 livehtml: docs
 	sphinx-autobuild $(AUTOSPHINXOPTS) $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)
@@ -52,8 +52,8 @@ pypi:   tag
 	## version depends on tag, so re-tagging doesn't make sense
 
 upload: pypi
-	git push --tags
+	git push-all --tags
 
 update:
-	pip install -r requirements_dev.txt
+	pip install -r ci/test-requirements.txt