#1631 - Added the DEFCON 703 header to all possible files

This commit is contained in:
Chris McCarthy
2023-07-17 19:28:43 +01:00
parent 3186fcb489
commit 678f953ced
68 changed files with 109 additions and 7 deletions

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
..
Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
..

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
..
Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates.
..

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
..
DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without
which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden

View File

@@ -1,3 +1,4 @@
# Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
Welcome to PrimAITE's documentation
====================================

View File

@@ -1,4 +1,8 @@
.. _about:
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
.. _about:
About PrimAITE
==============

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
.. _config:
The Config Files Explained

View File

@@ -1,4 +1,8 @@
Custom Agents
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
Custom Agents
=============

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
.. role:: raw-html(raw)
:format: html

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
.. _getting-started:
Getting Started

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
Glossary
=============

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
v1.2 to v2.0 Migration guide
============================

View File

@@ -1,3 +1,7 @@
.. only:: comment
Crown Copyright (C) Dstl 2022. DEFCON 703. Shared in confidence.
.. _run a primaite session:
Run a PrimAITE Session
@@ -44,7 +48,8 @@ For example, when running a session at 17:30:00 on 31st January 2023, the sessio
``~/primaite/sessions/2023-01-31/2023-01-31_17-30-00/``.
Loading a session
-------
-----------------
A previous session can be loaded by providing the **directory** of the previous session to either the ``primaite session`` command from the cli
(See :func:`primaite.cli.session`), or by calling :func:`primaite.main.run` with session_path.