Skip to content

Commit 1397b01

Browse files
committed
misc docs and repo configs
1 parent d7b7d58 commit 1397b01

File tree

9 files changed

+116
-2
lines changed

9 files changed

+116
-2
lines changed

.editorconfig

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

.github/ISSUE_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
* Python version:
2+
* numpy version:
3+
* matplotlib version:
4+
* mpl-probscale version:
5+
* Operating System:
6+
7+
### Description
8+
9+
Describe what you were trying to get done.
10+
Tell us what happened, what went wrong, and what you expected to happen.
11+
12+
### What I Did
13+
14+
```
15+
Paste the command(s) you ran and the output.
16+
If there was a crash, please include the traceback here.
17+
```

AUTHORS.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Paul M. Hobson <pmhobson@gmail.com>
9+
10+
Contributors
11+
------------
12+
13+
* Pierre Haessig

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Configuring Sublime Text 3 to run the tests
119119
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120120

121121
In Sublime, got to Tools -> Build System -> New Build System.
122-
Then add the following configuration and save as "wqio.sublime-build"::
122+
Then add the following configuration and save as "probscale.sublime-build"::
123123

124124
{
125125
"working_dir": "<path to the git repository>",
@@ -134,7 +134,7 @@ In Atom, install the build_ package, create a new file called ".atom-build.yml"
134134
top level of the project directory, and add the following contents::
135135

136136
cmd: "<full path of the python executable>"
137-
name: "wqio"
137+
name: "probscale"
138138
args:
139139
- check_probscale.py
140140
- --verbose

docs/authors.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../AUTHORS.rst

docs/contributing.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../CONTRIBUTING.rst

docs/installation.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. highlight:: shell
2+
3+
============
4+
Installation
5+
============
6+
7+
8+
Stable release
9+
--------------
10+
11+
To install mpl-probscale, run this command in your terminal:
12+
13+
.. code-block:: console
14+
15+
$ pip install probscale
16+
17+
This is the preferred method to install mpl-probscale, as it will always install the most recent stable release.
18+
19+
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
20+
you through the process.
21+
22+
.. _pip: https://pip.pypa.io
23+
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24+
25+
26+
From sources
27+
------------
28+
29+
The sources for mpl-probscale can be downloaded from the `Github repo`_.
30+
31+
You can either clone the public repository:
32+
33+
.. code-block:: console
34+
35+
$ git clone git://github.com/phobson/probscale
36+
37+
Or download the `tarball`_:
38+
39+
.. code-block:: console
40+
41+
$ curl -OL https://github.com/phobson/probscale/tarball/master
42+
43+
Once you have a copy of the source, you can install it with:
44+
45+
.. code-block:: console
46+
47+
$ pip install .
48+
49+
50+
.. _Github repo: https://github.com/phobson/probscale
51+
.. _tarball: https://github.com/phobson/probscale/tarball/master

docs/readme.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../README.rst

setup.cfg

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
[metadata]
22
description-file = readme.md
3+
4+
[tool:pytest]
5+
pep8ignore =
6+
E501
7+
E131
8+
wqio/tests/test_features.py E241
9+
wqio/tests/test_datacollections.py E241
10+
wqio/tests/test_ros.py E241
11+
docs/* ALL

0 commit comments

Comments
 (0)