sartography
/
spiff-arena
mirror of https://github.com/sartography/spiff-arena.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add mermaid charts

This commit is contained in:
burnettk 2024-05-01 09:46:42 -04:00
parent c3ca3e4079
commit 0911d16749
No known key found for this signature in database
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/conf.py
View File

@ -10,19 +10,18 @@
# if we want that again some day, here were the docs in that sub-folder docs dir: # if we want that again some day, here were the docs in that sub-folder docs dir:
# https://github.com/sartography/spiff-arena/blob/d9b303db782b1004a818c426283e9cfbc5ed0ec7/spiffworkflow-backend/docs/conf.py # https://github.com/sartography/spiff-arena/blob/d9b303db782b1004a818c426283e9cfbc5ed0ec7/spiffworkflow-backend/docs/conf.py
project = 'SpiffWorkflow' project = "SpiffWorkflow"
copyright = '2023, Sartography' copyright = "2023, Sartography"
author = 'Sartography' # Very ok to add your name here. author = "Sartography" # Very ok to add your name here.
release = '0.1' release = "0.1"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ['myst_parser'] extensions = ["myst_parser", "sphinxcontrib.mermaid"]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"]
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
@ -30,21 +29,21 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
# html_theme = 'alabaster' # html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme" html_theme = "sphinx_rtd_theme"
html_static_path = ['static'] html_static_path = ["static"]
html_logo = "spiffworkflow_logo.png" html_logo = "spiffworkflow_logo.png"
html_theme_options = { html_theme_options = {
'logo_only': True, "logo_only": True,
'display_version': False, "display_version": False,
'prev_next_buttons_location': 'bottom', "prev_next_buttons_location": "bottom",
'style_external_links': False, "style_external_links": False,
'vcs_pageview_mode': '', "vcs_pageview_mode": "",
# Toc options # Toc options
'collapse_navigation': False, "collapse_navigation": False,
'sticky_navigation': True, "sticky_navigation": True,
'navigation_depth': 4, "navigation_depth": 4,
'includehidden': True, "includehidden": True,
'titles_only': False "titles_only": False,
} }

1
docs/requirements.txt
View File

@ -44,6 +44,7 @@ sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1 sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.7 sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10 sphinxcontrib-serializinghtml==1.1.10
sphinxcontrib-mermaid==0.9.2
tornado==6.4 tornado==6.4
typeguard==4.2.1 typeguard==4.2.1
Unidecode==1.3.8 Unidecode==1.3.8