Skip to content

Commit bcf6a1e

Browse files
committed
update: docs and schematic
1 parent 594f06a commit bcf6a1e

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

docs/source/dev/actions_and_webhooks.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Github Actions and Webhooks
44
Actions
55
--------------
66

7-
Currently, this project makes use of 3 `Github Actions <https://github.com/features/actions>`_,
7+
Currently, this project makes use of 4 `Github Actions <https://github.com/features/actions>`_,
88
which can be found in the
99
`.github/workflows <https://github.com/CITCOM-project/CausalTestingFramework/tree/main/.github/workflows>`_ directory.
1010

@@ -16,14 +16,18 @@ They are:
1616

1717
#. ``publish-to-pypi.yaml``, runs when a new version tag is pushed and publishes that tag version to PyPI.
1818

19+
#. ``figshare.yaml``, releases new versions to `Figshare <https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516?file=43686015>`_.
20+
21+
#. ``publish-to-dafni.yaml``, which containerises and uploads every major release to `DAFNI <https://www.dafni.ac.uk/>`_.
22+
23+
1924
Webhooks
2025
---------------
2126

22-
The project also uses 3 `Webhooks <https://docs.github.com/en/webhooks-and-events/webhooks/about-webhooks>`_, which can
27+
The project also uses 2 `Webhooks <https://docs.github.com/en/webhooks-and-events/webhooks/about-webhooks>`_, which can
2328
be found in the `project settings <https://github.com/CITCOM-project/CausalTestingFramework/settings>`_ on Github. These
2429
include:
2530

26-
#. `Codacy <https://github.com/codacy>`_
2731

2832
#. `Codecov <https://github.com/codecov>`_
2933

docs/source/images/workflow.png

-180 KB
Binary file not shown.

docs/source/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Causal testing is a :term:`causal inference`-driven framework for functional bla
1010
graphical causal inference (CI) techniques for the specification and functional testing of software from a black-box
1111
perspective. In this framework, we use causal directed acyclic graphs (DAGs) to express the anticipated cause-effect
1212
relationships amongst the inputs and outputs of the system-under-test and the supporting mathematical framework to
13-
relationships amongst the inputs and outputs of the system-under-test and the supporting mathematical framework to
1413
design statistical procedures capable of making causal inferences. Each causal test case focuses on the causal effect
1514
of an intervention made to the system-under test. That is, a prescribed change to the input configuration of the
1615
system-under-test that is expected to cause a change to some output(s).
@@ -37,7 +36,7 @@ system-under-test that is expected to cause a change to some output(s).
3736
}
3837
3938
.zoom-container.zoomed {
40-
transform: scale(2);
39+
transform: scale(4);
4140
cursor: zoom-out;
4241
}
4342
@@ -84,7 +83,7 @@ system-under-test that is expected to cause a change to some output(s).
8483

8584
.. container:: zoom-container
8685

87-
.. image:: /images/workflow.png
86+
.. image:: /images/schematic.png
8887
:class: zoomable-image
8988
:alt: Zoomable Image
9089

@@ -93,6 +92,8 @@ system-under-test that is expected to cause a change to some output(s).
9392
:hidden:
9493
:caption: Home
9594

95+
self
96+
9697
.. toctree::
9798
:hidden:
9899
:maxdepth: 1

0 commit comments

Comments
 (0)