Skip to content

Commit

Permalink
build based on 79bebf2
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 20, 2023
1 parent 8893f35 commit afad531
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion previews/PR40/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-20T04:24:40","documenter_version":"1.0.1"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-20T04:40:16","documenter_version":"1.0.1"}}
4 changes: 2 additions & 2 deletions previews/PR40/gallery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<dd>
<div id="GraceJMO2007">M. D. Grace, C. Brif, H. Rabitz, D. A. Lidar, I. A. Walmsley and R. L. Kosut. <i>Fidelity of optimally controlled quantum gates with randomly coupled multiparticle environments</i>. <a href='https://doi.org/10.1080/09500340701639615'>J. Mod. Opt. <b>54</b>, 2339 (2007)</a>, <a href='https://arxiv.org/abs/0712.2935'>arXiv:0712.2935</a>.</div>
</dd>
</dl></div><p>This works because the <code>DocumenterCitations</code> plugin automatically upgrades <code>style=:alpha</code> to the internal</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DocumenterCitations.AlphaStyle" href="#DocumenterCitations.AlphaStyle"><code>DocumenterCitations.AlphaStyle</code></a><span class="docstring-category">Type</span></header><section><div><p>&quot;Smart&quot; alphabetic citation style (relative to the &quot;dumb&quot; <code>:alpha</code>).</p><pre><code class="language-julia hljs">style = AlphaStyle()</code></pre><p>instantiates a style for <a href="../internals/#DocumenterCitations.CitationBibliography"><code>CitationBibliography</code></a> that avoids duplicate labels. Any of the entries that would result in the same label will be disambiguated by appending the suffix &quot;a&quot;, &quot;b&quot;, etc.</p><p>Any bibliography that cites a subset of the given <code>entries</code> is guaranteed to have unique labels.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/DocumenterCitations.jl/blob/042c2119e57e9607040c11aaa6d280f975ce7a5d/src/DocumenterCitations.jl#L97-L110">source</a></section></article><h2 id="custom_styles"><a class="docs-heading-anchor" href="#custom_styles">Custom styles</a><a id="custom_styles-1"></a><a class="docs-heading-anchor-permalink" href="#custom_styles" title="Permalink"></a></h2><p>In the following, we show two examples for user-defined styles. See the <a href="../internals/#customization">notes on customization</a> on how to generally define a custom style.</p><h3 id="Custom-style:-enumerated-author-year"><a class="docs-heading-anchor" href="#Custom-style:-enumerated-author-year">Custom style: enumerated author-year</a><a id="Custom-style:-enumerated-author-year-1"></a><a class="docs-heading-anchor-permalink" href="#Custom-style:-enumerated-author-year" title="Permalink"></a></h3><p>In this example, the <code>:authoryear</code> style is used, but the references are shown in an enumerated list.</p><pre><code class="language-julia hljs">import DocumenterCitations
</dl></div><p>This works because the <code>DocumenterCitations</code> plugin automatically upgrades <code>style=:alpha</code> to the internal</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="DocumenterCitations.AlphaStyle" href="#DocumenterCitations.AlphaStyle"><code>DocumenterCitations.AlphaStyle</code></a><span class="docstring-category">Type</span></header><section><div><p>&quot;Smart&quot; alphabetic citation style (relative to the &quot;dumb&quot; <code>:alpha</code>).</p><pre><code class="language-julia hljs">style = AlphaStyle()</code></pre><p>instantiates a style for <a href="../internals/#DocumenterCitations.CitationBibliography"><code>CitationBibliography</code></a> that avoids duplicate labels. Any of the entries that would result in the same label will be disambiguated by appending the suffix &quot;a&quot;, &quot;b&quot;, etc.</p><p>Any bibliography that cites a subset of the given <code>entries</code> is guaranteed to have unique labels.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/DocumenterCitations.jl/blob/79bebf22b0bc2f8e25935e5d1d955a06e7bae5d9/src/DocumenterCitations.jl#L97-L110">source</a></section></article><h2 id="custom_styles"><a class="docs-heading-anchor" href="#custom_styles">Custom styles</a><a id="custom_styles-1"></a><a class="docs-heading-anchor-permalink" href="#custom_styles" title="Permalink"></a></h2><p>In the following, we show two examples for user-defined styles. See the <a href="../internals/#customization">notes on customization</a> on how to generally define a custom style.</p><h3 id="Custom-style:-enumerated-author-year"><a class="docs-heading-anchor" href="#Custom-style:-enumerated-author-year">Custom style: enumerated author-year</a><a id="Custom-style:-enumerated-author-year-1"></a><a class="docs-heading-anchor-permalink" href="#Custom-style:-enumerated-author-year" title="Permalink"></a></h3><p>In this example, the <code>:authoryear</code> style is used, but the references are shown in an enumerated list.</p><pre><code class="language-julia hljs">import DocumenterCitations

function DocumenterCitations.format_bibliography_reference(::Val{:enumauthoryear}, entry)
text = DocumenterCitations.format_bibliography_reference(:authoryear, entry)
Expand Down Expand Up @@ -99,4 +99,4 @@
<dd>
<div id="WinckelIP2008">G. von Winckel and A. Borzì. <i>Computational techniques for a quantum control problem with H$^1$-cost</i>. <a href='https://doi.org/10.1088/0266-5611/24/3/034007'>Inverse Problems <b>24</b>, 034007 (2008)</a>.</div>
</dd>
</dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../syntax/">« Syntax</a><a class="docs-footer-nextpage" href="../styling/">CSS Styling »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:24">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../syntax/">« Syntax</a><a class="docs-footer-nextpage" href="../styling/">CSS Styling »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:40">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR40/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@
<dd>
<div id="GoerzQ2022">M. H. Goerz, S. C. Carrasco and V. S. Malinovsky. <i>Quantum Optimal Control via Semi-Automatic Differentiation</i>. <a href='https://doi.org/10.22331/q-2022-12-07-871'>Quantum <b>6</b>, 871 (2022)</a>.</div>
</dd>
</dl></div><p>Also see the <a href="references/#References">full bibliography</a> for further references cited throughout this documentation.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="syntax/">Syntax »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:24">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</dl></div><p>Also see the <a href="references/#References">full bibliography</a> for further references cited throughout this documentation.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="syntax/">Syntax »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:40">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions previews/PR40/internals/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR40/references/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,4 @@
<dd>
<div id="jax">J. Bradbury, R. Frostig, P. Hawkins, M. J. Johnson, C. Leary, D. Maclaurin, G. Necula, A. Paszke, J. VanderPlas, S. Wanderman-Milne and Q. Zhang. <a href='https://github.com/google/jax'><i>JAX: composable transformations of Python+NumPy programs</i></a>.</div>
</dd>
</dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../internals/">« Internals</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:24">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../internals/">« Internals</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:40">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR40/styling/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
),
plugins=[bib],
# ...
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gallery/">« Citation Style Gallery</a><a class="docs-footer-nextpage" href="../internals/">Internals »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:24">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gallery/">« Citation Style Gallery</a><a class="docs-footer-nextpage" href="../internals/">Internals »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.2.1-dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.0.1 on <span class="colophon-date" title="Wednesday 20 September 2023 04:40">Wednesday 20 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit afad531

Please sign in to comment.