Skip to content

Commit 8d83bd4

Browse files
committed
Update docs
1 parent 3887610 commit 8d83bd4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+12772
-1091
lines changed

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ gen-docs:
22
pip install -r docs/requirements.txt
33
cd docs; make html
44
install:
5-
python setup.py build
6-
python setup.py install
5+
python3 setup.py build
6+
python3 setup.py install
77
release:
8-
python setup.py register
9-
python setup.py sdist upload
8+
python3 setup.py register
9+
python3 setup.py sdist upload
7.56 KB
Binary file not shown.

docs/_build/doctrees/index.doctree

984 Bytes
Binary file not shown.
102 Bytes
Binary file not shown.
-12 Bytes
Binary file not shown.

docs/_build/doctrees/usage.doctree

5.92 KB
Binary file not shown.

docs/_build/html/.buildinfo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: ee5cd29150f916bdf6484059a38263a3
4-
tags: fbb0d17656682115ca4d033fb2f83ba1
3+
config: fb1593a245f7e07127d7d4782b82f954
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. git-pylint-commit-hook documentation master file, created by
2+
sphinx-quickstart on Fri Dec 6 12:58:30 2013.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to git-pylint-commit-hook's documentation!
7+
==================================================
8+
9+
Contents:
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
installation
15+
usage
16+
license
17+
18+
Overview
19+
--------
20+
21+
The ``git-pylint-commit-hook`` is a tool for checking Python code using ``pylint`` before the code is committed to git.
22+
23+
All files that end with ``.py`` or that have ``python`` in the she bang will be automatically checked before they are committed to the repo.
24+
25+
26+
Author
27+
------
28+
29+
This project is maintained by `Sebastian Dahlgren <http://www.sebastiandahlgren.se>`_ (`GitHub <https://github.com/sebdah>`_ | `Twitter <https://twitter.com/sebdah>`_ | `LinkedIn <http://www.linkedin.com/in/sebastiandahlgren>`_)
30+
31+
32+
Source code
33+
-----------
34+
35+
The source code is available on the projects `GitHub repository <https://github.com/sebdah/git-pylint-commit-hook>`_.
36+
37+
38+
Indices and tables
39+
==================
40+
41+
* :ref:`genindex`
42+
* :ref:`modindex`
43+
* :ref:`search`
44+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Installation
2+
============
3+
4+
Use ``pip`` to install ``git-pylint-commit-hook``.
5+
::
6+
7+
pip install git-pylint-commit-hook
8+
9+
10+
The command ``git-pylint-commit-hook`` will now be accessible in your system.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
License
2+
=======
3+
4+
APACHE LICENSE 2.0
5+
Copyright 2013 Sebastian Dahlgren
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
`http://www.apache.org/licenses/LICENSE-2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.

0 commit comments

Comments
 (0)