Skip to content

Commit

Permalink
deploy: 4674188
Browse files Browse the repository at this point in the history
  • Loading branch information
tomtrafford committed Jul 11, 2023
1 parent 6ac082c commit 3cde400
Show file tree
Hide file tree
Showing 26 changed files with 47 additions and 261 deletions.
2 changes: 1 addition & 1 deletion main/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5591260332315308331de0ceaaad95eb
config: 5777a1a3854b056731bd8b7a2c538325
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified main/.doctrees/developer/index.doctree
Binary file not shown.
Binary file modified main/.doctrees/developer/reference/standards.doctree
Binary file not shown.
Binary file modified main/.doctrees/environment.pickle
Binary file not shown.
8 changes: 0 additions & 8 deletions main/_sources/developer/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ side-bar.
:caption: Tutorials
:maxdepth: 1

tutorials/dev-install

+++

Tutorials for getting up and running as a developer.
Expand All @@ -26,14 +24,8 @@ side-bar.
:maxdepth: 1

how-to/contribute
how-to/build-docs
how-to/run-tests
how-to/static-analysis
how-to/lint
how-to/update-tools
how-to/make-release
how-to/pin-requirements
how-to/test-container
how-to/run-container

+++
Expand Down
56 changes: 0 additions & 56 deletions main/_sources/developer/reference/standards.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,59 +6,3 @@ repository.

Code Standards
--------------

The code in this repository conforms to standards set by the following tools:

- black_ for code formatting
- flake8_ for style checks
- isort_ for import ordering
- mypy_ for static type checking

.. seealso::

How-to guides `../how-to/lint` and `../how-to/static-analysis`

.. _documentation_standards:

Documentation Standards
-----------------------

Docstrings are pre-processed using the Sphinx Napoleon extension. As such,
google-style_ is considered as standard for this repository. Please use type
hints in the function signature for types. For example:

.. code:: python
def func(arg1: str, arg2: int) -> bool:
"""Summary line.
Extended description of function.
Args:
arg1: Description of arg1
arg2: Description of arg2
Returns:
Description of return value
"""
return True
.. _google-style: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy

Documentation is contained in the ``docs`` directory and extracted from
docstrings of the API.

Docs follow the underlining convention::

Headling 1 (page title)
=======================

Heading 2
---------

Heading 3
~~~~~~~~~

.. seealso::

How-to guide `../how-to/build-docs`
2 changes: 1 addition & 1 deletion main/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.1.dev65+g5ad11e0',
VERSION: '0.1.dev66+g4674188',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
14 changes: 2 additions & 12 deletions main/developer/explanations/decisions.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Architectural Decision Records &#8212; PandABlocks.github.io 0.1.dev65+g5ad11e0 documentation</title>
<title>Architectural Decision Records &#8212; PandABlocks.github.io 0.1.dev66+g4674188 documentation</title>



Expand Down Expand Up @@ -372,21 +372,11 @@
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../tutorials/dev-install.html">Developer install</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../how-to/contribute.html">Contributing to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/build-docs.html">Build the docs using sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/run-tests.html">Run the tests using pytest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/static-analysis.html">Run static analysis using mypy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/lint.html">Run linting using pre-commit</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/update-tools.html">Update the tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/make-release.html">Make a release</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/pin-requirements.html">Pinning Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/test-container.html">Container Local Build and Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how-to/run-container.html">Run in a container</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>1. Record architecture decisions &#8212; PandABlocks.github.io 0.1.dev65+g5ad11e0 documentation</title>
<title>1. Record architecture decisions &#8212; PandABlocks.github.io 0.1.dev66+g4674188 documentation</title>



Expand Down Expand Up @@ -372,21 +372,11 @@
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev-install.html">Developer install</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../how-to/contribute.html">Contributing to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/build-docs.html">Build the docs using sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-tests.html">Run the tests using pytest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/static-analysis.html">Run static analysis using mypy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/lint.html">Run linting using pre-commit</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/update-tools.html">Update the tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/make-release.html">Make a release</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/pin-requirements.html">Pinning Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/test-container.html">Container Local Build and Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-container.html">Run in a container</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>2. Adopt python3-pip-skeleton for project structure &#8212; PandABlocks.github.io 0.1.dev65+g5ad11e0 documentation</title>
<title>2. Adopt python3-pip-skeleton for project structure &#8212; PandABlocks.github.io 0.1.dev66+g4674188 documentation</title>



Expand Down Expand Up @@ -372,21 +372,11 @@
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/dev-install.html">Developer install</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../how-to/contribute.html">Contributing to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/build-docs.html">Build the docs using sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-tests.html">Run the tests using pytest</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/static-analysis.html">Run static analysis using mypy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/lint.html">Run linting using pre-commit</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/update-tools.html">Update the tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/make-release.html">Make a release</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/pin-requirements.html">Pinning Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/test-container.html">Container Local Build and Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-to/run-container.html">Run in a container</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
Expand Down
26 changes: 8 additions & 18 deletions main/developer/how-to/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Contributing to the project &#8212; PandABlocks.github.io 0.1.dev65+g5ad11e0 documentation</title>
<title>Contributing to the project &#8212; PandABlocks.github.io 0.1.dev66+g4674188 documentation</title>



Expand Down Expand Up @@ -52,8 +52,8 @@
<link rel="icon" href="../../_static/PandA-logo.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Build the docs using sphinx" href="build-docs.html" />
<link rel="prev" title="Developer install" href="../tutorials/dev-install.html" />
<link rel="next" title="Update the tools" href="update-tools.html" />
<link rel="prev" title="Developer Guide" href="../index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -372,21 +372,11 @@
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../tutorials/dev-install.html">Developer install</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="build-docs.html">Build the docs using sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-tests.html">Run the tests using pytest</a></li>
<li class="toctree-l1"><a class="reference internal" href="static-analysis.html">Run static analysis using mypy</a></li>
<li class="toctree-l1"><a class="reference internal" href="lint.html">Run linting using pre-commit</a></li>
<li class="toctree-l1"><a class="reference internal" href="update-tools.html">Update the tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="make-release.html">Make a release</a></li>
<li class="toctree-l1"><a class="reference internal" href="pin-requirements.html">Pinning Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="test-container.html">Container Local Build and Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-container.html">Run in a container</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
Expand Down Expand Up @@ -496,20 +486,20 @@ <h2>Developer guide<a class="headerlink" href="#developer-guide" title="Permalin
<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="../tutorials/dev-install.html"
href="../index.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Developer install</p>
<p class="prev-next-title">Developer Guide</p>
</div>
</a>
<a class="right-next"
href="build-docs.html"
href="update-tools.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Build the docs using sphinx</p>
<p class="prev-next-title">Update the tools</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
20 changes: 5 additions & 15 deletions main/developer/how-to/make-release.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Make a release &#8212; PandABlocks.github.io 0.1.dev65+g5ad11e0 documentation</title>
<title>Make a release &#8212; PandABlocks.github.io 0.1.dev66+g4674188 documentation</title>



Expand Down Expand Up @@ -52,7 +52,7 @@
<link rel="icon" href="../../_static/PandA-logo.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Pinning Requirements" href="pin-requirements.html" />
<link rel="next" title="Run in a container" href="run-container.html" />
<link rel="prev" title="Update the tools" href="update-tools.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
Expand Down Expand Up @@ -372,21 +372,11 @@
<div class="sidebar-primary-item"><nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../tutorials/dev-install.html">Developer install</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">How-to Guides</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="build-docs.html">Build the docs using sphinx</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-tests.html">Run the tests using pytest</a></li>
<li class="toctree-l1"><a class="reference internal" href="static-analysis.html">Run static analysis using mypy</a></li>
<li class="toctree-l1"><a class="reference internal" href="lint.html">Run linting using pre-commit</a></li>
<li class="toctree-l1"><a class="reference internal" href="update-tools.html">Update the tools</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Make a release</a></li>
<li class="toctree-l1"><a class="reference internal" href="pin-requirements.html">Pinning Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="test-container.html">Container Local Build and Test</a></li>
<li class="toctree-l1"><a class="reference internal" href="run-container.html">Run in a container</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explanations</span></p>
Expand Down Expand Up @@ -493,11 +483,11 @@ <h1>Make a release<a class="headerlink" href="#make-a-release" title="Permalink
</div>
</a>
<a class="right-next"
href="pin-requirements.html"
href="run-container.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Pinning Requirements</p>
<p class="prev-next-title">Run in a container</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
Loading

0 comments on commit 3cde400

Please sign in to comment.