Skip to content

Commit

Permalink
Cookiecutter cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
emlove committed May 3, 2020
1 parent 62bc3bb commit 858438c
Show file tree
Hide file tree
Showing 19 changed files with 18 additions and 375 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ python:
- 3.8
- 3.7
- 3.6
- 3.5

# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
install: pip install -U tox-travis
Expand Down
23 changes: 1 addition & 22 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,6 @@ 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
~~~~~~~~~~~~~~~~~~~

pyzerproc could always use more documentation, whether as part of the
official pyzerproc docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -102,7 +95,7 @@ Before you submit a pull request, check that it meets these guidelines:
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
3. The pull request should work for Python 3.6, 3.7 and 3.8, and for PyPy. Check
https://travis-ci.com/emlove/pyzerproc/pull_requests
and make sure that the tests pass for all supported Python versions.

Expand All @@ -112,17 +105,3 @@ Tips
To run a subset of tests::

$ pytest tests.test_pyzerproc


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::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
8 changes: 0 additions & 8 deletions HISTORY.rst

This file was deleted.

3 changes: 1 addition & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst

recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
recursive-include *.rst conf.py Makefile make.bat *.jpg *.png *.gif
13 changes: 1 addition & 12 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: clean clean-test clean-pyc clean-build docs help
.PHONY: clean clean-test clean-pyc clean-build help
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
Expand Down Expand Up @@ -62,17 +62,6 @@ coverage: ## check code coverage quickly with the default Python
coverage html
$(BROWSER) htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/pyzerproc.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ pyzerproc
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html

servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: dist ## package and upload a release
twine upload dist/*

Expand Down
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ Features

* TODO

Changelog
---------
0.0.1 (2020-05-03)
~~~~~~~~~~~~~~~~~~
- Initial release

Credits
-------

Expand Down
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

162 changes: 0 additions & 162 deletions docs/conf.py

This file was deleted.

1 change: 0 additions & 1 deletion docs/contributing.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/history.rst

This file was deleted.

19 changes: 0 additions & 19 deletions docs/index.rst

This file was deleted.

51 changes: 0 additions & 51 deletions docs/installation.rst

This file was deleted.

Loading

0 comments on commit 858438c

Please sign in to comment.