Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5af063b
commit 529e03d
Showing
3 changed files
with
48 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters