mirror of
https://github.com/sprockets/cookiecutter-sprockets.git
synced 2024-11-23 11:19:52 +00:00
5bb05e461d
- Documentation updates, fleshing out more of the baseline expectations - README.rst updates with the baseline expectations - Remove tornado from the requirements.txt - Update the nosetests configuration in setup.cfg - Remove unneeded 2.6 requirements - Update classifiers - Update name in cookiecutter.json - Use manual package names in packages - Mark as non-zip safe - Remove tests directory - Make default tests.py file - Explicitly add coverage to the test requirements - Add README.rst to MANIFEST.in - Update Trove classifiers - Ensure setup.py will include README.rst and LICENSE (dupe of MANIFEST.in) - Add test_suite to setup.py - Set default description in cookiecutter.json Additional refactoring - Change to be a sprockets.foo.bar project - Move doc to docs - Add additional documentation templates - Change version to only show major.minor - Add docs/Makefile - Minor README and docs updates Fix the travis file and readthedocs URLs Deployment/pypi related updates
55 lines
No EOL
2.2 KiB
ReStructuredText
55 lines
No EOL
2.2 KiB
ReStructuredText
sprockets.{{ cookiecutter.project_name }}
|
|
{{ '=' * (10 + cookiecutter.project_name|length) }}
|
|
{{ cookiecutter.description }}
|
|
|
|
|Version| |Downloads| |Status| |Coverage| |License|
|
|
|
|
Installation
|
|
------------
|
|
sprockets.{{ cookiecutter.project_name }} is available on the
|
|
`Python Package Index <https://pypi.python.org/pypi/sprockets.{{ cookiecutter.project_name }}>`_
|
|
and can be installed via ``pip`` or ``easy_install``:
|
|
|
|
.. code:: bash
|
|
|
|
pip install sprockets.{{ cookiecutter.project_name }}
|
|
|
|
Documentation
|
|
-------------
|
|
https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org
|
|
|
|
Requirements
|
|
------------
|
|
@TODO: Put full requirements list here, should match requirements.text
|
|
- `sprockets <https://github.com/sprockets/sprockets>`_
|
|
|
|
Example
|
|
-------
|
|
This examples demonstrates how to use sprockets.{{ cookiecutter.project_name }} by ...
|
|
.. code:: python
|
|
|
|
from sprockets import {{ cookiecutter.project_name }}
|
|
|
|
# Example here
|
|
|
|
More complex examples and documentation are available at https://sprockets.{{ cookiecutter.project_name }}.readthedocs.org
|
|
|
|
Version History
|
|
---------------
|
|
Available at https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org/en/latest/history.html
|
|
|
|
.. |Version| image:: https://badge.fury.io/py/sprockets.{{ cookiecutter.project_name }}.svg?
|
|
:target: http://badge.fury.io/py/sprockets.{{ cookiecutter.project_name }}
|
|
|
|
.. |Status| image:: https://travis-ci.org/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?branch=master
|
|
:target: https://travis-ci.org/sprockets/sprockets.{{ cookiecutter.project_name }}
|
|
|
|
.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?
|
|
.. |Coverage| image:: https://coveralls.io/repos/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?
|
|
:target: https://coveralls.io/r/sprockets/sprockets.{{ cookiecutter.project_name }}
|
|
|
|
.. |Downloads| image:: https://pypip.in/d/sprockets.{{ cookiecutter.project_name }}/badge.svg?
|
|
:target: https://pypi.python.org/pypi/sprockets.{{ cookiecutter.project_name }}
|
|
|
|
.. |License| image:: https://pypip.in/license/sprockets.{{ cookiecutter.project_name }}/badge.svg?
|
|
:target: https://sprockets{{ cookiecutter.project_name.replace('.', '') }}.readthedocs.org |