Repository navigation
doc: add a workflow overview page - #27
Merged
Merged
Conversation
Documentation build overview
27 files changed ·
|
…ow diagram to each guide page
…rade pages from the front page
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
guide/workflow.md, a page of Mermaid flowcharts with a MATLAB and a Python tab. Each diagram orders the stages from project set-up to analysis, with the parallel kcat sources, the alternative tuning and relaxation paths and the optional steps. A table lists each stage with the stage it runs after, its functions and its output.guide/index.mdhas a Workflow section with a thumbnail that links to the page.docs/conf.pyloadssphinxcontrib.mermaidandrequirements.txtlists it. The viewer's browser loads mermaid.js from a CDN.docs/_static/workflow-overview.pngis a screenshot of the MATLAB diagram.docs/_staticand are rendered again when the diagram changes.docs/_static/custom.css: a thinner header and sidebar, and a wider article column.The diagrams were rendered in Chromium without syntax errors.
sphinx-build -Wpasses. The branch is based ondocs/gecko4-changes(#26) because the page links to pages added there.