Experiment Architecture Doc [Resolves #579] #580
Conversation
Codecov Report
@@ Coverage Diff @@
## master #580 +/- ##
==========================================
+ Coverage 82.23% 82.49% +0.25%
==========================================
Files 84 83 -1
Lines 4875 4833 -42
==========================================
- Hits 4009 3987 -22
+ Misses 866 846 -20
Continue to review full report at Codecov.
|
docs/mkdocs.yml
Outdated
| @@ -5,6 +5,9 @@ repo_url: http://github.com/dssg/triage | |||
| edit_uri: blob/master/docs/templates | |||
| site_description: 'Documentation for Triage.' | |||
|
|
|||
| markdown_extensions: | |||
| - inline_graphviz | |||
There was a problem hiding this comment.
Not sure why I'm getting Config value: 'markdown_extensions'. Error: Failed loading extension "inline_graphviz". when I ran mkdocs serve.
There was a problem hiding this comment.
Same issue here.
Not sure if this applies.
@thcrock Any reason you can think of that we'd see that discrepancy between our machines?
There was a problem hiding this comment.
The change suggested in that Github issue, changing the markdown extension reference to "mdx_inline_graphviz," gets docs to serve.
However, this is the error I see when I navigate to the architecture docs page (/experiments/architecture/):
There was a problem hiding this comment.
I wonder if the difference in my machine is that I have graphviz itself installed (on the system!) while it's probably not in requirements. I'll look into it
There was a problem hiding this comment.
I don't see a possibility for pure python graphviz: achieving this inline may be impossible without also having the user install graphviz on their own. The graphviz python package generates DOT files using Python but depends on the dot executable to run.
It may be easier to just bundle the DOT files, render these as images, and making it a needed step to rerender them to update the doc. Not as cool as inline, but may be necessary.
There was a problem hiding this comment.
Or....it looks like instead of graphviz I can do this with Mermaid: squidfunk/mkdocs-material#693
There was a problem hiding this comment.
It actually looks way better with mermaid, even though there is a bit more work to get it started in a doc. Pushing changes soon
There was a problem hiding this comment.
Works. And, agreed, much nicer.
docs/mkdocs.yml
Outdated
| @@ -5,6 +5,9 @@ repo_url: http://github.com/dssg/triage | |||
| edit_uri: blob/master/docs/templates | |||
| site_description: 'Documentation for Triage.' | |||
|
|
|||
| markdown_extensions: | |||
| - inline_graphviz | |||
There was a problem hiding this comment.
Same issue here.
Not sure if this applies.
@thcrock Any reason you can think of that we'd see that discrepancy between our machines?
docs/mkdocs.yml
Outdated
| @@ -5,6 +5,9 @@ repo_url: http://github.com/dssg/triage | |||
| edit_uri: blob/master/docs/templates | |||
| site_description: 'Documentation for Triage.' | |||
|
|
|||
| markdown_extensions: | |||
| - inline_graphviz | |||
There was a problem hiding this comment.
The change suggested in that Github issue, changing the markdown extension reference to "mdx_inline_graphviz," gets docs to serve.
However, this is the error I see when I navigate to the architecture docs page (/experiments/architecture/):
|
I say @tweddielin, look good to you? |
|
@thcrock Out of place, I know; but, in reviewing, I saw the "upgrading an experiment" links were garbled. So, fixed, in a piggy-backed commit.
|
- Fill in experiment architecture document - Use mermaid to embed dependency graphs without having to prerender anything
thcrock
force-pushed
the
architecture_doc
branch
from
2e69c7a
to
9e42e09
Compare
|
FYI, I recommitted my "out of place" change to master; but, the inline review suggestions, which had been accepted and committed, appear to have been lost in the force-push, (I assume because they weren't first pulled down from Github/origin). |
needing to prerender anything.