Skip to content

Commit

Permalink
Added info about the commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Bernardo-MG committed Jan 12, 2018
1 parent 5af063b commit 529e03d
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.rst
Expand Up @@ -23,9 +23,9 @@ Projects created with this template come with the following features:
- Travis configuration file
- Customized setup.py module to minimize configuration, and using tox for the tests
- Docs using `Sphinx`_ and the `Sphinx Docs Theme`_
- Run tests or build the docs with a command
- Prepared to run tests through tox
- Prepared to run tests on Python 2 and 3
- Prepared to run tests on pypy and pypy 3
- Prepared to run tests on Python 3 and pypy 3
- Prepared to run coverage tests and integrate with `Coveralls`_
- Prepared to run tests for the `Sphinx`_ documentation

Expand Down
41 changes: 41 additions & 0 deletions docs/source/building.rst
@@ -0,0 +1,41 @@
====================
Building the project
====================

The new project will make use of `setuptools`_, and comes with a setup.py already set up.

--------
Commands
--------

The setup.py file comes ready for all the usual commands.

A few additional commands are added.

~~~~~
Tests
~~~~~

To run the tests:

.. code-block:: sh
$ python setup.py test
Or running the tests using a profile:

.. code-block:: sh
$ python setup.py test -p py36
~~~~
Docs
~~~~

To build the docs:

.. code-block:: sh
$ python setup.py build_docs
.. _setuptools: https://github.com/pypa/setuptools
7 changes: 5 additions & 2 deletions docs/source/index.rst
Expand Up @@ -13,10 +13,12 @@ Features

- Travis configuration file
- Customized setup.py module to minimize configuration, and using tox for the tests
- Run tests with a command
- Docs using `Sphinx`_ and the `Sphinx Docs Theme`_
- Build the docs with a command
- Prepared to run tests through tox
- Prepared to run tests on Python 3.4, 3.5, 3.6
- Prepared to run tests on pypy and pypy 3
- Prepared to run tests on Python 3
- Prepared to run tests on pypy 3
- Prepared to run coverage tests and integrate with `Coveralls`_
- Prepared to run tests for the `Sphinx`_ documentation

Expand All @@ -25,6 +27,7 @@ Features

acquire
usage
building
doc_site
tests

Expand Down

0 comments on commit 529e03d

Please sign in to comment.