Retrospective notes

Author: Tom-Willemsen

.gitignore

@@ -1,3 +1,4 @@
 .idea/*
 .venv/
 ibex_developers_manual.egg-info/
+build/

doc/Retrospective-Notes.md

@@ -0,0 +1,11 @@
+Retrospective Notes
+===================
+
+.. toctree::
+   :titlesonly:
+   :reversed:
+   :caption: Retrospective Notes
+   :glob:
+   :maxdepth: 1
+   
+   retrospective-notes/*

doc/Retrospective-Notes.rst

@@ -27,7 +27,7 @@
     ("py:obj", r"^.*\.T.*_co$"),
 ]
 
-myst_enable_extensions = ["dollarmath", "strikethrough", "colon_fence"]
+myst_enable_extensions = ["dollarmath", "strikethrough", "colon_fence", "linkify"]
 suppress_warnings = ["myst.strikethrough"]
 
 extensions = [

doc/conf.py

@@ -1,28 +1,4 @@
-
-
-Welcome to ibex_bluesky_core's documentation!
-=============================================
-
-``ibex_bluesky_core`` is a library of common ``bluesky`` functionality and ``ophyd-async``
-devices for use on the ISIS neutron & muon source's beamlines.
-
-`Bluesky <https://blueskyproject.io/bluesky/main/index.html>`_ is a generic data acquisition
-framework, which started at NSLS-ii but is developed as a multi-facility collaboration. Bluesky
-provides concepts such as "scanning" in a generic way.
-
-`ophyd-async <https://blueskyproject.io/ophyd-async/main/index.html>`_ is a python device
-abstraction library, which allows bluesky to communicate with an underlying control system
-(EPICS/IBEX, in our case).
-
-``ibex_bluesky_core`` provides:
-
-- Central configuration for core bluesky classes, such as the ``RunEngine``.
-- ``RunEngine`` Callbacks customized for use at ISIS: file writing, plotting, fitting, ...
-- Central implementations of ISIS device classes using ``ophyd-async``: Blocks, DAE, ...
-- Bluesky or scanning-related utilities which are useful across multiple beamlines.
-
-
-Getting started
+IBEX Developer's manual
 ===============
 
 .. toctree::
@@ -31,76 +7,9 @@ Getting started
    :glob:
 
    tutorial/overview.md
-
-Reference documentation
-=======================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Devices
-   :glob:
-   
-   devices/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Callbacks
-   :glob:
-
-   callbacks/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Fitting
-   :glob:
-
-   fitting/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Plan stubs
-   :glob:
-
-   plan_stubs/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Plans
-   :glob:
-
-   plans/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Plans (Reflectometry)
-   :glob:
-
-   plans/reflectometry/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Preprocessors
-   :glob:
-
-   preprocessors/*
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Developer information
-   :glob:
-
-   dev/*
 
 .. toctree::
-   :titlesonly:
-   :caption: Architectural decisions
-   :glob:
    :maxdepth: 1
-
-   architectural_decisions/*
-
-.. toctree::
-   :titlesonly:
-   :caption: API reference
-
-   _api
+   :caption: Retrospective Notes
+   
+   Retrospective-Notes.rst

doc/index.rst

@@ -1,5 +1,4 @@
-> [Wiki](Home) > [Project overview](Project-Overview) > [Notes from Retrospectives](Retrospective-Notes) > [Retrospective Notes 2018.02.14](Retrospective-Notes-2018.02.14)
-
+# 2018-02-14
 
 ## Sprint_2018_01_18
 #### Date of Sprint Retrospective: 14-02-2018

doc/Retrospective-Notes-2018.02.14.md renamed to doc/retrospective-notes/Retrospective-Notes-2018.02.14.md

@@ -1,7 +1,8 @@
-> [Wiki](Home) > [Project overview](Project-Overview) > [Notes from Retrospectives](Retrospective-Notes) > [Retrospective Notes 2018.03.14](Retrospective-Notes-2018.03.14)
+# 2018-03-14
 
 ## Sprint_2018_02_15
-#### Date of Sprint Retrospective: 14-03-2018
+
+### Date of Sprint Retrospective: 14-03-2018
 
 1. Build Performance
    * builds are now much faster.

doc/Retrospective-Notes-2018.03.14.md renamed to doc/retrospective-notes/Retrospective-Notes-2018.03.14.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [Project overview](Project-Overview) > [Notes from Retrospectives](Retrospective-Notes) > [Retrospective Notes 2018.09.26](Retrospective-Notes-2018.09.26)
+# 2018-09-26
 
 1. Want to put Tools in one place. [John: maybe 2 - deployed and non-deployed]. Examples are
         - config checker

doc/Retrospective-Notes-2018.09.26.md renamed to doc/retrospective-notes/Retrospective-Notes-2018.09.26.md

@@ -1,3 +1,5 @@
+# 2018-10-29
+
 Generally slow sprint because of holidays. Please announce holidays to Kevin where possible so it can be planned in.
 
 * Should we automatically measure how long tickets took?

doc/Retrospective-Notes-2018.10.29.md renamed to doc/retrospective-notes/Retrospective-Notes-2018.10.29.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [Project overview](Project-Overview) > [Notes from Retrospectives](Retrospective-Notes) > [Sprint Ending 2018-11-21](Retrospective-Notes-2018.11.21)
+# 2018-11-21
 
 Short sprint with too many tickets made it weird; make sure next sprint is reasonable.