Skip to content

Commit

Permalink
deploy: 1f97a14
Browse files Browse the repository at this point in the history
  • Loading branch information
@machow
machow committed Jun 14, 2024
1 parent e9e983f commit 0675c2a
Show file tree
Hide file tree
Showing 7 changed files with 102 additions and 18 deletions.
10 changes: 5 additions & 5 deletions examples/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <h6 class="anchored">
<p></p>
</div>
<div class="card border-2 rounded-3 g-col-12 g-col-sm-12 g-col-md-6 g-col-lg-4 mb-2">
<a class="gallery-href" href="https://rstudio.github.io/py-shinyswatch/">
<a class="gallery-href" href="https://posit-dev.github.io/py-shinyswatch/">
<div class="card-header py-1 px-2 border-bottom border-1 bg-light">
<h6 class="anchored">
Shinyswatch
Expand All @@ -212,12 +212,12 @@ <h6 class="anchored">
<div class="gallery-card-body">
<img src="images/shinyswatch-home.jpeg">
</div>
</a><ul class="gallery-links"><a class="gallery-href" href="https://rstudio.github.io/py-shinyswatch/">
</a><li><a class="gallery-href" href="https://rstudio.github.io/py-shinyswatch/">
</a><a class="view-reference" href="https://rstudio.github.io/py-shinyswatch/reference">Reference Page</a>
</a><ul class="gallery-links"><a class="gallery-href" href="https://posit-dev.github.io/py-shinyswatch/">
</a><li><a class="gallery-href" href="https://posit-dev.github.io/py-shinyswatch/">
</a><a class="view-reference" href="https://posit-dev.github.io/py-shinyswatch/reference">Reference Page</a>
</li>
<li>
<a class="view-source" href="https://github.com/rstudio/py-shinyswatch">Source</a>
<a class="view-source" href="https://github.com/posit-dev/py-shinyswatch">Source</a>
</li>
</ul>
<p></p>
Expand Down
4 changes: 2 additions & 2 deletions get-started/dev-big-picture.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ <h2 class="anchored" data-anchor-id="the-builder">The Builder</h2>
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a>builder <span class="op">=</span> Builder.from_quarto_config(cfg)</span>
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true" tabindex="-1"></a>builder</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="1">
<pre><code>&lt;quartodoc.autosummary.BuilderPkgdown at 0x7f49f46c28f0&gt;</code></pre>
<pre><code>&lt;quartodoc.autosummary.BuilderPkgdown at 0x7f479855a950&gt;</code></pre>
</div>
</div>
<p>Note that .from_quarto_config used the <code>style:</code> field to decide which Builder to create (in this case, <code>BuilderPkgdown</code>).</p>
Expand Down Expand Up @@ -534,7 +534,7 @@ <h2 class="anchored" data-anchor-id="rendering-and-writing">Rendering and writin
<div class="cell" data-execution_count="9">
<div class="sourceCode cell-code" id="cb17"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>builder.renderer</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="9">
<pre><code>&lt;quartodoc.renderers.md_renderer.MdRenderer at 0x7f49f46d6380&gt;</code></pre>
<pre><code>&lt;quartodoc.renderers.md_renderer.MdRenderer at 0x7f479856e470&gt;</code></pre>
</div>
</div>
<p>The <code>render</code> method of of the <a href="../api/MdRenderer.html#quartodoc.MdRenderer"><code>MdRenderer</code></a> returns a markdown string that can be rendered by Quarto:</p>
Expand Down
10 changes: 5 additions & 5 deletions get-started/dev-docstrings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,11 +439,11 @@ <h3 class="anchored" data-anchor-id="parsed-docstring">Parsed docstring</h3>
<div class="cell" data-execution_count="5">
<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>f_obj.docstring.parsed</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="5">
<pre><code>[&lt;griffe.docstrings.dataclasses.DocstringSectionText at 0x7efe70291150&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionParameters at 0x7efe70293ca0&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionAdmonition at 0x7efe683f4ca0&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionExamples at 0x7efe683f4df0&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionReturns at 0x7efe683f43a0&gt;]</code></pre>
<pre><code>[&lt;griffe.docstrings.dataclasses.DocstringSectionText at 0x7fc270397820&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionParameters at 0x7fc2703971f0&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionAdmonition at 0x7fc2604618a0&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionExamples at 0x7fc260461780&gt;,
&lt;griffe.docstrings.dataclasses.DocstringSectionReturns at 0x7fc260461690&gt;]</code></pre>
</div>
</div>
<p>The docstring into a tree lets us define visitors, which can visit each element and do useful things. For example, print a high-level overview of its structure, or render it to markdown.</p>
Expand Down
19 changes: 18 additions & 1 deletion get-started/interlinks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -383,11 +383,15 @@ <h2 class="anchored" data-anchor-id="configuring-the-interlinks-filter">Configur
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">numpy</span><span class="kw">:</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://numpy.org/doc/stable/</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">python</span><span class="kw">:</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://docs.python.org/3/</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://docs.python.org/3/</span></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">quartodoc-test</span><span class="kw">:</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://machow.github.io/quartodoc</span></span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">inv</span><span class="kw">:</span><span class="at"> objects-test.txt</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Notice 2 important pieces in this config:</p>
<ul>
<li>The <code>numpy</code> and <code>python</code> fields indicate that we’re getting inventories for the library numpy, and python builtin libraries.</li>
<li>The <code>url</code> fields indicate where inventory files can be found.</li>
<li>The <code>inv</code> field lets you specify the name of the inventory file. By default, it assumes its <code>objects.inv</code>.</li>
</ul>
<p>By default, downloaded inventory files will be saved in the <code>_inv</code> folder of your documentation directory.</p>
<section id="experimental-fast-option" class="level3">
Expand Down Expand Up @@ -526,6 +530,19 @@ <h2 class="anchored" data-anchor-id="what-is-a-sphinx-inventory-file">What is a
<li>python: https://docs.python.org/3/objects.inv</li>
</ul>
<p>See the <a href="https://sphobjinv.readthedocs.io/en/stable/">sphobjinv docs</a> for thorough details on these files, and how they’re used in sphinx.</p>
<div class="callout-note callout callout-style-default callout-captioned">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-caption-container flex-fill">
Note
</div>
</div>
<div class="callout-body-container callout-body">
<p><a href="https://github.com/machow/quartodoc/tree/main/docs/objects-test.txt">objects-test.txt</a> is an example file with one entry: <a href="https://pr-350–quartodoc.netlify.app/api/Auto.html#quartodoc.Auto"><code>qd2.Auto</code></a>.</p>
</div>
</div>
</section>
<section id="more-information" class="level2">
<h2 class="anchored" data-anchor-id="more-information">More information</h2>
Expand Down
5 changes: 5 additions & 0 deletions objects-test.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sphinx inventory version 2
# Project: quartodoc
# Version: 0.0.9999
# The remainder of this file is compressed using zlib.
qd2.Auto py:class 1 api/Auto.html#quartodoc.Auto -
62 changes: 62 additions & 0 deletions objects.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Sphinx inventory version 2
# Project: quartodoc
# Version: 0.0.9999
# The remainder of this file is compressed using zlib.
quartodoc.Auto py:class 1 api/Auto.html#quartodoc.Auto -
quartodoc.layout.Auto py:class 1 api/Auto.html#quartodoc.Auto quartodoc.Auto
quartodoc.blueprint py:function 1 api/blueprint.html#quartodoc.blueprint -
quartodoc.builder.blueprint.blueprint py:function 1 api/blueprint.html#quartodoc.blueprint quartodoc.blueprint
quartodoc.collect py:function 1 api/collect.html#quartodoc.collect -
quartodoc.builder.collect.collect py:function 1 api/collect.html#quartodoc.collect quartodoc.collect
quartodoc.get_object py:function 1 api/get_object.html#quartodoc.get_object -
quartodoc.autosummary.get_object py:function 1 api/get_object.html#quartodoc.get_object quartodoc.get_object
quartodoc.preview py:function 1 api/preview.html#quartodoc.preview -
quartodoc.ast.preview py:function 1 api/preview.html#quartodoc.preview quartodoc.preview
quartodoc.MdRenderer py:class 1 api/MdRenderer.html#quartodoc.MdRenderer -
quartodoc.renderers.md_renderer.MdRenderer py:class 1 api/MdRenderer.html#quartodoc.MdRenderer quartodoc.MdRenderer
quartodoc.MdRenderer.render py:function 1 api/MdRenderer.render.html#quartodoc.MdRenderer.render -
quartodoc.renderers.md_renderer.MdRenderer.render py:function 1 api/MdRenderer.render.html#quartodoc.MdRenderer.render quartodoc.MdRenderer.render
quartodoc.MdRenderer.render_annotation py:function 1 api/MdRenderer.render_annotation.html#quartodoc.MdRenderer.render_annotation -
quartodoc.renderers.md_renderer.MdRenderer.render_annotation py:function 1 api/MdRenderer.render_annotation.html#quartodoc.MdRenderer.render_annotation quartodoc.MdRenderer.render_annotation
quartodoc.MdRenderer.render_header py:function 1 api/MdRenderer.render_header.html#quartodoc.MdRenderer.render_header -
quartodoc.renderers.md_renderer.MdRenderer.render_header py:function 1 api/MdRenderer.render_header.html#quartodoc.MdRenderer.render_header quartodoc.MdRenderer.render_header
quartodoc.MdRenderer.signature py:function 1 api/MdRenderer.signature.html#quartodoc.MdRenderer.signature -
quartodoc.renderers.md_renderer.MdRenderer.signature py:function 1 api/MdRenderer.signature.html#quartodoc.MdRenderer.signature quartodoc.MdRenderer.signature
quartodoc.MdRenderer.summarize py:function 1 api/MdRenderer.summarize.html#quartodoc.MdRenderer.summarize -
quartodoc.renderers.md_renderer.MdRenderer.summarize py:function 1 api/MdRenderer.summarize.html#quartodoc.MdRenderer.summarize quartodoc.MdRenderer.summarize
quartodoc.Builder py:class 1 api/Builder.html#quartodoc.Builder -
quartodoc.autosummary.Builder py:class 1 api/Builder.html#quartodoc.Builder quartodoc.Builder
quartodoc.Builder.from_quarto_config py:function 1 api/Builder.from_quarto_config.html#quartodoc.Builder.from_quarto_config -
quartodoc.autosummary.Builder.from_quarto_config py:function 1 api/Builder.from_quarto_config.html#quartodoc.Builder.from_quarto_config quartodoc.Builder.from_quarto_config
quartodoc.Builder.build py:function 1 api/Builder.build.html#quartodoc.Builder.build -
quartodoc.autosummary.Builder.build py:function 1 api/Builder.build.html#quartodoc.Builder.build quartodoc.Builder.build
quartodoc.Builder.write_index py:function 1 api/Builder.write_index.html#quartodoc.Builder.write_index -
quartodoc.autosummary.Builder.write_index py:function 1 api/Builder.write_index.html#quartodoc.Builder.write_index quartodoc.Builder.write_index
quartodoc.Builder.write_doc_pages py:function 1 api/Builder.write_doc_pages.html#quartodoc.Builder.write_doc_pages -
quartodoc.autosummary.Builder.write_doc_pages py:function 1 api/Builder.write_doc_pages.html#quartodoc.Builder.write_doc_pages quartodoc.Builder.write_doc_pages
quartodoc.Builder.write_sidebar py:function 1 api/Builder.write_sidebar.html#quartodoc.Builder.write_sidebar -
quartodoc.autosummary.Builder.write_sidebar py:function 1 api/Builder.write_sidebar.html#quartodoc.Builder.write_sidebar quartodoc.Builder.write_sidebar
quartodoc.Builder.create_inventory py:function 1 api/Builder.create_inventory.html#quartodoc.Builder.create_inventory -
quartodoc.autosummary.Builder.create_inventory py:function 1 api/Builder.create_inventory.html#quartodoc.Builder.create_inventory quartodoc.Builder.create_inventory
quartodoc.create_inventory py:function 1 api/create_inventory.html#quartodoc.create_inventory -
quartodoc.inventory.create_inventory py:function 1 api/create_inventory.html#quartodoc.create_inventory quartodoc.create_inventory
quartodoc.convert_inventory py:function 1 api/convert_inventory.html#quartodoc.convert_inventory -
quartodoc.inventory.convert_inventory py:function 1 api/convert_inventory.html#quartodoc.convert_inventory quartodoc.convert_inventory
quartodoc.layout.Layout py:class 1 api/layout.Layout.html#quartodoc.layout.Layout -
quartodoc.layout.Section py:class 1 api/layout.Section.html#quartodoc.layout.Section -
quartodoc.layout.Page py:class 1 api/layout.Page.html#quartodoc.layout.Page -
quartodoc.layout.SectionElement py:attribute 1 api/layout.SectionElement.html#quartodoc.layout.SectionElement -
quartodoc.layout.ContentElement py:attribute 1 api/layout.ContentElement.html#quartodoc.layout.ContentElement -
quartodoc.layout.Doc py:class 1 api/layout.Doc.html#quartodoc.layout.Doc -
quartodoc.layout.DocFunction py:class 1 api/layout.DocFunction.html#quartodoc.layout.DocFunction -
quartodoc.layout.DocAttribute py:class 1 api/layout.DocAttribute.html#quartodoc.layout.DocAttribute -
quartodoc.layout.DocModule py:class 1 api/layout.DocModule.html#quartodoc.layout.DocModule -
quartodoc.layout.DocClass py:class 1 api/layout.DocClass.html#quartodoc.layout.DocClass -
quartodoc.layout.Link py:class 1 api/layout.Link.html#quartodoc.layout.Link -
quartodoc.layout.Item py:class 1 api/layout.Item.html#quartodoc.layout.Item -
quartodoc.layout.ChoicesChildren py:class 1 api/layout.ChoicesChildren.html#quartodoc.layout.ChoicesChildren -
quartodoc.ast.DocstringSectionSeeAlso py:class 1 api/ast.DocstringSectionSeeAlso.html#quartodoc.ast.DocstringSectionSeeAlso -
quartodoc.ast.DocstringSectionNotes py:class 1 api/ast.DocstringSectionNotes.html#quartodoc.ast.DocstringSectionNotes -
quartodoc.ast.DocstringSectionWarnings py:class 1 api/ast.DocstringSectionWarnings.html#quartodoc.ast.DocstringSectionWarnings -
quartodoc.ast.ExampleCode py:class 1 api/ast.ExampleCode.html#quartodoc.ast.ExampleCode -
quartodoc.ast.ExampleText py:class 1 api/ast.ExampleText.html#quartodoc.ast.ExampleText -
Loading

0 comments on commit 0675c2a

Please sign in to comment.