M docs/doctasks.py => docs/doctasks.py +3 -1
@@ 99,7 99,9 @@ def render_page(page, template, out_html):
error(f"{e} in {page}")
raise SystemExit(1)
- title = f"{title} | yatte"
+ if not title.startswith("Yatte"):
+ title = f"{title} | yatte"
+
stderr(f"$ compile {page_template} {page} > {out_html}")
rendered = template.format(title=title, content=content, date=date.today())
out_html.write_text(rendered)
M docs/pages/development.html => docs/pages/development.html +6 -6
@@ 2,13 2,13 @@
<h1>Development</h1>
-<p>In order to run project-related tasks defined in <code>tasks.py</code>,
+<p>In order to run the project-related tasks defined in <code>tasks.py</code>,
<code class="cmd">yatte</code> itself must first be installed:</p>
<pre><code><span class="gp">$ </span>pip install .</code></pre>
-<p>The package can now be installed in development mode
- via <code class="cmd">yatte</code> itself:</p>
+<p>The package can then be reïnstalled in development mode,
+ along with the dependencies for the development tasks:</p>
<pre><code><span class="gp">$ </span>yatte setup</code></pre>
@@ 17,9 17,9 @@
<pre><code><span class="gp">$ </span>yatte
<span class="gp">$ </span>yatte fmt <span class="c1"># etc.</span></code></pre>
-<p>To add a pre-commit hook to check the code when committing,
- write the following to <code>.git/hook/pre-commit</code>
- and <code class="cmd">chmod +x</code> it:</p>
+<p>The code can be checked automatically when making a Git commit
+ by saving the following script as <code>.git/hook/pre-commit</code>
+ and making it executable with <code class="cmd">chmod +x</code>:</p>
<pre><code><span class="ch">#!/bin/sh -e</span>
yatte check</code></pre>