Deployed 04801e4 with MkDocs version: 1.6.1

404.html

@@ -263,6 +263,66 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/start/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Getting Started
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/config/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Configuration
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/rule-ref/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Rule Reference
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/cli/" class="md-nav__link">
 

about/index.html

@@ -270,6 +270,66 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../start/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Getting Started
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../config/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Configuration
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../rule-ref/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Rule Reference
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../cli/" class="md-nav__link">
 
@@ -584,18 +644,22 @@ <h2 id="contributions">Contributions</h2>
 For code and configuration changes, your PR must be linked to a 
 corresponding issue. </p>
 <h2 id="development">Development</h2>
-<p>To set up development environment, with repository root as current
-working directory:</p>
+<p>To install the XRLint development environment into an existing Python environment</p>
 <div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>.<span class="o">[</span>dev,doc<span class="o">]</span>
 </code></pre></div>
+<p>or create a new environment using</p>
+<div class="highlight"><pre><span></span><code>mamba<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>
+</code></pre></div>
 <h3 id="testing-and-coverage">Testing and Coverage</h3>
 <p>XRLint uses <a href="https://docs.pytest.org/">pytest</a> for unit-level testing 
 and code coverage analysis.</p>
 <div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>--cov<span class="o">=</span>xrlint<span class="w"> </span>--cov-report<span class="w"> </span>html
 </code></pre></div>
 <h3 id="code-style">Code Style</h3>
-<p>XRLint source code is formatted using the <a href="https://black.readthedocs.io/">black</a> tool.</p>
+<p>XRLint source code is formatted using the <a href="https://black.readthedocs.io/">black</a> tool and 
+quality-controlled using <a href="https://flake8.pycqa.org/">flake8</a>.</p>
 <div class="highlight"><pre><span></span><code>black<span class="w"> </span>.
+flake8<span class="w"> </span>--max-line-length<span class="o">=</span><span class="m">88</span><span class="w"> </span>.<span class="w"> </span>
 </code></pre></div>
 <h3 id="documentation">Documentation</h3>
 <p>XRLint documentation is built using the <a href="https://www.mkdocs.org/">mkdocs</a> tool.</p>
@@ -606,6 +670,10 @@ <h3 id="documentation">Documentation</h3>
 mkdocs<span class="w"> </span>serve
 mkdocs<span class="w"> </span>gh-deploy
 </code></pre></div>
+<p>The rule reference page is generated by a script called <code>mkruleref.py</code>.
+After changing or adding a rule, make sure you recreate the page:</p>
+<div class="highlight"><pre><span></span><code>python<span class="w"> </span>-m<span class="w"> </span>mkruleref
+</code></pre></div>
 <h2 id="license">License</h2>
 <p>XRLint is open source made available under the terms and conditions of the 
 <a href="https://github.com/bcdev/xrlint/blob/main/LICENSE">MIT License</a>.</p>