Skip to content

Commit

Permalink
Update Sphinx Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 16, 2023
1 parent a80fbe9 commit 08eacb3
Show file tree
Hide file tree
Showing 46 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion _sources/reference.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you use this software in a publication, please cite the software
title = {fastmachinelearning/hls4ml},
year = 2023,
publisher = {Zenodo},
version = {v0.8.0rc1},
version = {v0.8.0},
doi = {10.5281/zenodo.1201549},
url = {https://github.com/fastmachinelearning/hls4ml}
}
Expand Down
2 changes: 1 addition & 1 deletion advanced/accelerator.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion advanced/extension.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion advanced/fifo_depth.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion api/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion api/hls-model.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion api/profiling.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.fpga.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.fpga.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.quartus.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.quartus.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.symbolic.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.symbolic.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vitis.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vitis.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vivado.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vivado.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vivado_accelerator.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.backends.vivado_accelerator.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.converters.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.converters.keras.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.converters.onnx.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.converters.pytorch.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.model.flow.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.model.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.model.optimizer.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.model.optimizer.passes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.report.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion autodoc/hls4ml.writer.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<img src="../_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion command.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion details.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion flows.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -121,7 +121,7 @@ <h2>Citation<a class="headerlink" href="#citation" title="Permalink to this head
<span class="na">title</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{fastmachinelearning/hls4ml}</span><span class="p">,</span><span class="w"></span>
<span class="na">year</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="m">2023</span><span class="p">,</span><span class="w"></span>
<span class="na">publisher</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Zenodo}</span><span class="p">,</span><span class="w"></span>
<span class="na">version</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{v0.8.0rc1}</span><span class="p">,</span><span class="w"></span>
<span class="na">version</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{v0.8.0}</span><span class="p">,</span><span class="w"></span>
<span class="na">doi</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{10.5281/zenodo.1201549}</span><span class="p">,</span><span class="w"></span>
<span class="na">url</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{https://github.com/fastmachinelearning/hls4ml}</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
Expand Down
2 changes: 1 addition & 1 deletion release_notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion search.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<img src="_static/hls4ml_logo_navbar.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.0.dev5+gd9391dd9
0.9.0.dev6+ga9fc0fc6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
Loading

0 comments on commit 08eacb3

Please sign in to comment.