Skip to content

Commit bed03a7

Browse files
[DOCUMENTATION] Follow-up work on mermaid support for readthedocs.io (- WIP #413 -)
Changes in file docs/CI.md: * updated theme for diagrams for darkmode Changes in file docs/Testing.md: * updated theme for diagrams for darkmode Changes in file docs/conf.py: * fix for regression caused by last set of changes to docstrings
1 parent 0e3437b commit bed03a7

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

docs/CI.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ automated analysis.
7272
#### How on-`workflow_run` triggers propagate
7373

7474
```mermaid
75+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
7576
graph TD;
7677
PUSH-EVENT-->CI-Build.yml;
7778
CI-Build.yml-->multicast-build-*;
@@ -148,6 +149,7 @@ in a single environment on CircleCI, and typically perform faster.
148149
#### How `push` triggers propagate on CircleCI
149150

150151
```mermaid
152+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
151153
graph TD;
152154
PUSH-EVENT-->config.yml;
153155
config.yml-->build;
@@ -194,6 +196,7 @@ There are many integrations with various service providers used in the Multicast
194196
pipeline.
195197

196198
```mermaid
199+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
197200
graph TD;
198201
PUSH-EVENT["PUSH EVENT"];
199202
PUSH-EVENT-->CI-Build.yml;
@@ -370,6 +373,7 @@ Logically (e.g., ignoring complexities of concurrency and trigger conditionals,
370373
of phases is sequential per single CI/CD linter workflow.
371374

372375
```mermaid
376+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
373377
sequenceDiagram
374378
participant Repo as Repository
375379
@@ -471,6 +475,7 @@ Logically (e.g., ignoring complexities of concurrency and trigger conditionals,
471475
linters are all run independently per CI/CD linter workflow.
472476

473477
```mermaid
478+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
474479
graph TD;
475480
PUSH-EVENT-->bandit.yml;
476481
PUSH-EVENT-->codeql-analysis.yml;

docs/Testing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ for running the various tests during the act of testing.
104104
> Both CI/CD and the Makefile ultimately use the same test runner under the hood.
105105
106106
```mermaid
107+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
107108
graph TD;
108109
CI["CI/CD"];
109110
@@ -197,6 +198,7 @@ the selective test runner. Of course, eventually the process leads back to the n
197198
testing.
198199

199200
```mermaid
201+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
200202
sequenceDiagram
201203
actor user as Developer
202204
participant Make as Makefile
@@ -320,6 +322,7 @@ Here is how `multicast` module logging and code coverage collection are integrat
320322
whole testing process.
321323
322324
```mermaid
325+
%%{ init: { 'theme': 'base', 'themeVariables': { 'darkMode': true, 'primaryColor': '#3e3e3e', 'background': 'transparent', 'primaryBorderColor': 'Orange', 'lineColor': 'darkOrange', 'secondaryColor': 'transparent', 'tertiaryColor': '#030303' }} }%%
323326
sequenceDiagram
324327
actor user as Developer
325328
participant Make as Makefile

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -479,9 +479,9 @@ def linkcode_resolve(domain, info):
479479
True
480480
>>> type(res_text) is type(str())
481481
True
482-
>>> res_text is not test_text
482+
>>> len(res_text) > 0
483483
True
484-
>>> _conf.linkcode_resolve("py", info={"module": test_text,}) is res_text
484+
>>> res_text is not test_text
485485
True
486486
>>> _conf.linkcode_resolve("py", info={"module": ignored_input,}) is ignored_input
487487
True

0 commit comments

Comments
 (0)