Skip to content

Commit b53b1d8

Browse files
chfwchfw
committed
update documentation
1 parent 48332ce commit b53b1d8

File tree

9 files changed

+164
-20
lines changed

9 files changed

+164
-20
lines changed

‎.moban.d/docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
{%block SPHINX_EXTENSIONS%}
44
'sphinx.ext.autosummary',
5+
'sphinxcontrib.excel',
56
'sphinxcontrib.spelling'
67
{%endblock%}
78

@@ -14,4 +15,3 @@ def setup(app):
1415

1516

1617
{%endblock%}
17-

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ all: test
33
test:
44
bash test.sh
55

6-
document:
6+
doc:
77
bash document.sh
88

99
spelling:

‎README.rst

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ pyexcel-pygal - Let you focus on presentation with pygal
1111
.. image:: https://codecov.io/github/pyexcel/pyexcel-pygal/coverage.png
1212
:target: https://codecov.io/github/pyexcel/pyexcel-pygal
1313

14+
.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
15+
:target: https://gitter.im/pyexcel/Lobby
16+
1417
.. image:: https://readthedocs.org/projects/pyexcel-pygal/badge/?version=latest
1518
:target: http://pyexcel-pygal.readthedocs.org/en/latest/
1619

@@ -71,19 +74,39 @@ Then install relevant development requirements:
7174
#. pip install -r requirements.txt
7275
#. pip install -r tests/requirements.txt
7376

77+
Once you have finished your changes, please provide test case(s), relevant documentation
78+
and update CHANGELOG.rst.
79+
80+
.. note::
81+
82+
As to rnd_requirements.txt, usually, it is created when a dependent
83+
library is not released. Once the dependecy is installed
84+
(will be released), the future
85+
version of the dependency in the requirements.txt will be valid.
86+
87+
88+
How to test your contribution
89+
------------------------------
90+
91+
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
92+
93+
On Linux/Unix systems, please launch your tests like this::
94+
95+
$ make
96+
97+
On Windows systems, please issue this command::
98+
99+
> test.bat
100+
101+
How to update test environment and update documentation
102+
---------------------------------------------------------
74103

75-
In order to update test environment, and documentation, additional steps are
76-
required:
104+
Additional steps are required:
77105

78106
#. pip install moban
79107
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
80108
#. make your changes in `.moban.d` directory, then issue command `moban`
81109

82-
What is rnd_requirements.txt
83-
-------------------------------
84-
85-
Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
86-
87110
What is pyexcel-commons
88111
---------------------------------
89112

@@ -94,18 +117,15 @@ What is .moban.d
94117

95118
`.moban.d` stores the specific meta data for the library.
96119

97-
How to test your contribution
98-
------------------------------
120+
Acceptance criteria
121+
-------------------
99122

100-
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
123+
#. Has Test cases written
124+
#. Has all code lines tested
125+
#. Passes all Travis CI builds
126+
#. Has fair amount of documentation if your change is complex
127+
#. Agree on NEW BSD License for your contribution
101128

102-
On Linux/Unix systems, please launch your tests like this::
103-
104-
$ make
105-
106-
On Windows systems, please issue this command::
107-
108-
> test.bat
109129

110130

111131
License

‎docs/source/_static/handsontable.full.min.css

Lines changed: 31 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/source/_static/handsontable.full.min.js

Lines changed: 89 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎document.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx-build -b html docs/source docs/build

‎pyexcel-pygal.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ overrides: "pyexcel.yaml"
22
name: "pyexcel-pygal"
33
nick_name: "pygal"
44
version: "0.0.1"
5+
current_version: "0.0.1"
56
release: "0.0.1"
67
dependencies:
78
- pygal

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
NAME = 'pyexcel-pygal'
1212
AUTHOR = 'C.W.'
1313
VERSION = '0.0.1'
14-
EMAIL = 'wangc_2011 (at) hotmail.com'
14+
EMAIL = 'wangc_2011@hotmail.com'
1515
LICENSE = 'New BSD'
1616
DESCRIPTION = (
1717
'draw simple svg chart via pygal' +

‎tests/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
nose
2+
mock;python_version<"3"
23
codecov
34
coverage
45
flake8
56
pyexcel
7+
pyexcel-xls

0 commit comments

Comments
 (0)