This has to match my own rules.
This commit is contained in:
parent
873ccd3bbc
commit
3aa7cad2c6
11
index.html
11
index.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Welcome to Git Lint’s documentation! — Git Lint 0.0.6 documentation</title>
|
||||
<title>Git Lint — Git Lint 0.0.6 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="static/classic.css" type="text/css" />
|
||||
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
|
||||
|
|
@ -48,8 +48,11 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="welcome-to-git-lint-s-documentation">
|
||||
<h1>Welcome to Git Lint’s documentation!<a class="headerlink" href="#welcome-to-git-lint-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="git-lint">
|
||||
<h1>Git Lint<a class="headerlink" href="#git-lint" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Git Lint provides a new git command that automatically runs identifiable linters (style
|
||||
and syntax quality assurance programs) against changed files in your current git
|
||||
repository or staging area.</p>
|
||||
<p>Contents:</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
|
|
@ -110,7 +113,7 @@
|
|||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="#">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Welcome to Git Lint’s documentation!</a></li>
|
||||
<li><a class="reference internal" href="#">Git Lint</a></li>
|
||||
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
|
|||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
|
|
@ -25,7 +25,7 @@
|
|||
<script type="text/javascript" src="static/doctools.js"></script>
|
||||
<link rel="top" title="Git Lint 0.0.6 documentation" href="index.html" />
|
||||
<link rel="next" title="Installation" href="installation.html" />
|
||||
<link rel="prev" title="Welcome to Git Lint’s documentation!" href="index.html" />
|
||||
<link rel="prev" title="Git Lint" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
|
|
@ -41,7 +41,7 @@
|
|||
<a href="installation.html" title="Installation"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
<a href="index.html" title="Git Lint"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.6 documentation</a> »</li>
|
||||
</ul>
|
||||
|
|
@ -164,7 +164,7 @@ otherwise connected with the program is assumed by the user.</p>
|
|||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="index.html"
|
||||
title="previous chapter">Welcome to Git Lint’s documentation!</a></p>
|
||||
title="previous chapter">Git Lint</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="installation.html"
|
||||
title="next chapter">Installation</a></p>
|
||||
|
|
@ -202,7 +202,7 @@ otherwise connected with the program is assumed by the user.</p>
|
|||
<a href="installation.html" title="Installation"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="index.html" title="Welcome to Git Lint’s documentation!"
|
||||
<a href="index.html" title="Git Lint"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Git Lint 0.0.6 documentation</a> »</li>
|
||||
</ul>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -3,8 +3,12 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Git Lint's documentation!
|
||||
======================================
|
||||
Git Lint
|
||||
========
|
||||
|
||||
Git Lint provides a new git command that automatically runs identifiable linters (style
|
||||
and syntax quality assurance programs) against changed files in your current git
|
||||
repository or staging area.
|
||||
|
||||
Contents:
|
||||
|
||||
|
|
|
|||
|
|
@ -17,20 +17,8 @@ Options
|
|||
As a pre-commit hook:
|
||||
---------------------
|
||||
|
||||
.. code-block:: python
|
||||
There's a file, pre-commit, in the /bin directory with the project. (Or you can download
|
||||
it from the github repository.) Install it in you .git/hooks/pre-commit file, and
|
||||
chmod +x .git/hooks/pre-commit.
|
||||
|
||||
#!/usr/bin/env python
|
||||
import git_lint
|
||||
git_lint.run_precommit(staging = True, timestamps = True)
|
||||
|
||||
Install this file in your project's ``.git/hooks/pre-commit``, and set
|
||||
the file's executable flag to ``true``:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
chmod +x pre-commit
|
||||
|
||||
Please see the :ref:`api` for more details on options taken by the
|
||||
``run_precommit()`` and ``run_gitlint`` commands.
|
||||
|
||||
There is an example ``pre-commit`` script shipped with ``git lint``.
|
||||
The pre-commit hook is *experimental*. Please be careful with it.
|
||||
|
|
|
|||
17
usage.html
17
usage.html
|
|
@ -108,19 +108,10 @@
|
|||
</div>
|
||||
<div class="section" id="as-a-pre-commit-hook">
|
||||
<h2><a class="toc-backref" href="#id4">As a pre-commit hook:</a><a class="headerlink" href="#as-a-pre-commit-hook" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>
|
||||
<span class="kn">import</span> <span class="nn">git_lint</span>
|
||||
<span class="n">git_lint</span><span class="o">.</span><span class="n">run_precommit</span><span class="p">(</span><span class="n">staging</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">timestamps</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Install this file in your project’s <code class="docutils literal"><span class="pre">.git/hooks/pre-commit</span></code>, and set
|
||||
the file’s executable flag to <code class="docutils literal"><span class="pre">true</span></code>:</p>
|
||||
<div class="highlight-shell"><div class="highlight"><pre><span></span>chmod +x pre-commit
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Please see the <span class="xref std std-ref">api</span> for more details on options taken by the
|
||||
<code class="docutils literal"><span class="pre">run_precommit()</span></code> and <code class="docutils literal"><span class="pre">run_gitlint</span></code> commands.</p>
|
||||
<p>There is an example <code class="docutils literal"><span class="pre">pre-commit</span></code> script shipped with <code class="docutils literal"><span class="pre">git</span> <span class="pre">lint</span></code>.</p>
|
||||
<p>There’s a file, pre-commit, in the /bin directory with the project. (Or you can download
|
||||
it from the github repository.) Install it in you .git/hooks/pre-commit file, and
|
||||
chmod +x .git/hooks/pre-commit.</p>
|
||||
<p>The pre-commit hook is <em>experimental</em>. Please be careful with it.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue