zeroshade commented on code in PR #41455: URL: https://github.com/apache/arrow/pull/41455#discussion_r1601991199
########## docs/source/conf.py: ########## @@ -584,6 +587,9 @@ # # texinfo_no_detailmenu = False +# -- Options for mermaid output ------------------------------------------- + +mermaid_output_format = 'svg' Review Comment: If I remember correctly, it would require us to actually pull down and statically add the mermaid js script to our resulting documentation output, which also ended up interfering with the anchor links on the right side based on headings. The "zoom" and other features that mermaid-js provides ended up causing issues so it was better for us to pre-generate the images during building the docs and include those images rather than rely on manually including and picking a version of mermaid-js to add to our static files. from the sphixcontrib-mermaid docs: > The version of mermaid that will be used to parse raw output in HTML files. This should match a version available on https://unpkg.com/browse/mermaid/. The default is "10.2.0". If you need a newer version, you'll need to add the custom initialization. See below. > > If it's set to "", the lib won't be automatically included from the CDN service and you'll need to add it as a local file in html_js_files. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
