Skip to content

Commit 1acb380

Browse files
committed
Update contributing.rst and test sphinx build in Travis CI builds
1 parent 52ec168 commit 1acb380

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ before_install:
1111
- docker run --name arango -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd arangodb/arangodb:3.3.8
1212
- docker cp tests/static/service.zip arango:/tmp/service.zip
1313
install:
14-
- pip install flake8 mock pytest pytest-cov python-coveralls sphinx
14+
- pip install flake8 mock pytest pytest-cov python-coveralls sphinx sphinx_rtd_theme
1515
- pip install .
1616
script:
1717
- python -m flake8
1818
- python -m sphinx -b doctest docs build
19+
- python -m sphinx -b html -W docs build
1920
- py.test --complete -s -v --cov=arango
2021
after_success:
2122
- coveralls

docs/contributing.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ following **requirements**:
1616
and camel casing, and PEP8_ compliance (see below).
1717
* No classes/methods/functions with missing docstrings or commented-out lines.
1818
You can take a look at the existing code in python-arango for examples.
19-
* The test coverage_ remains at %100. Sometimes you may find yourself having to
20-
write superfluous unit tests to keep this number up. If a piece of code is
21-
trivial and has no need for unittests, use this_ to exclude it from coverage.
19+
* The test coverage_ remains at %100. You may find yourself having to write
20+
superfluous unit tests to keep this number up. If a piece of code is trivial
21+
and has no need for tests, use this_ to exclude it from coverage.
2222
* No build failures on TravisCI_. The builds automatically trigger on PR
2323
submissions.
2424
* Does not break backward-compatibility (unless there is a really good reason).
2525
* Compatibility with all supported Python versions: 2.7, 3.4, 3.5 and 3.6.
2626

2727
.. note::
2828
The dev branch is occasionally rebased_, and its commit history may be
29-
overwritten in the process. So before you begin feature work, git fetch or
29+
overwritten in the process. Before you begin feature work, git fetch or
3030
pull to ensure that your local branch has not diverged. If you see git
31-
conflicts and want to start from scratch, run this command:
31+
conflicts and want to start from scratch, run these commands:
3232

3333
.. code-block:: bash
3434
@@ -48,16 +48,16 @@ To ensure PEP8_ compliance, run flake8_:
4848
~$ cd python-arango
4949
~$ flake8
5050
51-
You should try to resolve all issues reported. If there is a good reason to
52-
ignore errors from a specific piece of code, visit here_ to see how to exclude
51+
You must resolve all issues reported. If there is a good reason to ignore
52+
errors coming from a specific piece of code, visit here_ to see how to exclude
5353
the lines.
5454

5555
Testing
5656
=======
5757

5858
To test your changes, run the integration test suite that comes with
5959
**python-arango** on your local machine. The test suite uses pytest_, and is
60-
designed to run against an actual database instance. Please use the latest
60+
designed to run against an actual ArangoDB instance. Please use the latest
6161
version of ArangoDB with the following configuration:
6262

6363
* **Host**: "localhost"
@@ -101,10 +101,11 @@ machine:
101101
~$ git clone https://github.com/joowani/python-arango.git
102102
~$ cd python-arango/docs
103103
~$ sphinx-build . build
104-
~$ # Open the generated file build/index.html in a browser
105104
105+
# Open the generated file build/index.html in a browser
106106
107-
As always, thanks for your contribution!
107+
108+
As always, thank you for your contribution!
108109

109110
.. _rebased: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
110111
.. _dev: https://github.com/joowani/python-arango/tree/dev

0 commit comments

Comments
 (0)