Skip to content

Commit

Permalink
Deployed 8afbe04 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Oct 18, 2023
1 parent 5edf93a commit 0003721
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion assets/NHSSYNTH.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion css/mkdocstrings.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ div.doc-contents:not(.first) {
/* Avoid breaking parameters name, etc. in table cells. */
td code {
word-break: normal !important;
}
}
2 changes: 1 addition & 1 deletion css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ a.external:hover::after, a.md-nav__link[href^="https:"]:hover::after {
margin-left: 0.2em;
content: ' ';
display: inline-block;
}
}
1 change: 1 addition & 0 deletions development_guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2420,6 +2420,7 @@ <h3 id="style">Style</h3>
</span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="n">known_first_party</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;nhssynth&quot;</span>
</span></code></pre></div>
<p>This ensure that absolute imports from <code>NHSSynth</code> are sorted separately from the rest of the imports in a file.</p>
<p>There are a number of other hooks used as part of this repositories pre-commit, including one that automatically mirrors the poetry version of these packages in the <code>dev</code> per the list of supported packages and <a href="https://github.com/nhsengland/NHSSynth/blob/main/.poetry-sync-db.json">.poetry-sync-db.json</a>. Roughly, these other hooks ensure correct formatting of <code>.yaml</code> and <code>.toml</code> files, checks for large files being added to a commit, strips notebook output from the files, and fixes whitespace and end-of-file issues. These are mostly consistent with the <a href="https://github.com/nhsx/analyticsunit-template/blob/hooks/.pre-commit-config.yaml">NHSx analytics project template's hooks</a></p>
<h3 id="documentation">Documentation</h3>
<p>There should be Google-style docstrings on all non-trivial functions and classes. Ideally a docstring should take the form:</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="n">arg1</span><span class="p">:</span> <span class="n">type1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">:</span> <span class="n">type2</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">returntype</span><span class="p">:</span>
Expand Down
2 changes: 1 addition & 1 deletion modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2275,7 +2275,7 @@ <h2 id="creating-a-new-module-and-folding-it-into-the-cli">Creating a new module
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 26, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 18, 2023</span>


</small>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion secure_mode/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2182,7 +2182,7 @@ <h1 id="opacus-secure-mode">Opacus' Secure Mode</h1>
<small>

Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 21, 2023</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 18, 2023</span>


</small>
Expand Down
Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 0003721

Please sign in to comment.