Skip to content

Commit

Permalink
[CIVIS-5427] DOC pin mermaid version for graph rendering in Sphinx do…
Browse files Browse the repository at this point in the history
…cs (#5)
  • Loading branch information
jacksonlee-civis authored Feb 24, 2023
1 parent 271558f commit 02b8015
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0bb5933af80c28b168a09848416a49ea
config: 4bfd3cf6192c12404221f739af79d3ef
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -556,7 +556,7 @@
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ <h2>T</h2>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -328,7 +328,7 @@ <h2>T</h2>
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -374,7 +374,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/more_examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,7 @@ <h2>Shared State Across Asynchronous Functions<a class="headerlink" href="#share
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -825,7 +825,7 @@ <h2>Shared State Across Asynchronous Functions<a class="headerlink" href="#share
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -347,7 +347,7 @@
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-01-05.
Copyright &#169; 2022 - 2023, Civis Analytics. Documentation last updated on 2023-02-24.
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s

Expand Down Expand Up @@ -243,7 +243,7 @@
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
<script src="https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>

<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
html_theme = 'furo'
html_static_path = ['_static']

# Pinning mermaid version due to https://github.com/mgaitan/sphinxcontrib-mermaid/issues/110
mermaid_version = "9.4.0"

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None)
}
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name = "async-graph-data-flow"
version = "1.0.0"
description = "Asynchronous functions that pass data along a directed acyclic graph"
readme = "README.md"
requires-python = ">= 3.10.*"
requires-python = ">= 3.10"
license = { text = "BSD 3-Clause" }
authors = [ { name = "Civis Analytics", email = "[email protected]" } ]
keywords = [
Expand Down Expand Up @@ -50,7 +50,7 @@ dev = [
"furo == 2022.9.29",
"numpydoc == 1.5.0",
"sphinx-copybutton == 0.5.1",
"sphinxcontrib-mermaid == 0.7.1",
"sphinxcontrib-mermaid == 0.8",
]

[tool.setuptools.packages.find]
Expand Down

0 comments on commit 02b8015

Please sign in to comment.