github/cookiecutter-sprockets
1
0
Fork 0
mirror of https://github.com/sprockets/cookiecutter-sprockets.git synced 2024-11-23 19:29:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
cookiecutter-sprockets/sprockets.{{cookiecutter.project_name}}/docs/index.rst

67 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Updates to many things - 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
2014-08-28 23:25:02 +00:00
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 }}
Requirements
------------
Multiple updates - Speed up travis testing - Fix typo in index.rst - Add sprockets to requirements.txt - Remove version importing in setup.py
2014-08-29 14:30:12 +00:00
@TODO: Put full requirements list here, should match requirements.txt
Updates to many things - 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
2014-08-28 23:25:02 +00:00
- `sprockets <https://github.com/sprockets/sprockets>`_
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api
examples
Version History
---------------
See :doc:`history`
Issues
------
Please report any issues to the Github project at `https://github.com/sprockets/sprockets.{{ cookiecutter.project_name }}/issues <https://github.com/sprockets/sprockets.{{ cookiecutter.project_name }}/issues>`_
Source
------
Fix travis testing for Python 2.6 and minor doc cleanup
2014-08-29 17:12:01 +00:00
``sprockets.{{ cookiecutter.project_name }}`` source is available on Github at `https://github.com/sprockets/sprockets.{{ cookiecutter.project_name }} <https://github.com/sprockets/sprockets.{{ cookiecutter.project_name }}>`_
Updates to many things - 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
2014-08-28 23:25:02 +00:00
License
-------
Fix travis testing for Python 2.6 and minor doc cleanup
2014-08-29 17:12:01 +00:00
``sprockets.{{ cookiecutter.project_name }}`` is released under the `3-Clause BSD license <https://github.com/sprockets/sprockets.{{ cookiecutter.project_name }}/blob/master/LICENSE>`_.
Updates to many things - 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
2014-08-28 23:25:02 +00:00
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. |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 }}
Fix the coveralls badge
2014-08-29 03:39:43 +00:00
.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.{{ cookiecutter.project_name }}.svg?
Updates to many things - 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
2014-08-28 23:25:02 +00:00
: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
Reference in a new issue Copy permalink