Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdancho84 committed Sep 29, 2023
1 parent fc1960a commit 9438d5e
Show file tree
Hide file tree
Showing 20 changed files with 190 additions and 130 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"hash": "1d4b00d8fea30f9bbb9a80d51866b6cd",
"hash": "182db38c4c9cc2c06603601c9965729c",
"result": {
"markdown": "---\ntitle: Install\ntoc: true\ntoc-depth: 3\nnumber-sections: true\nnumber-depth: 2\n---\n\n::: {.callout-warning collapse=\"false\"}\n## Under Development\n\nThis library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0. \n:::\n\n## Quick Install\n\nLet's get you up and running with `timetk` fast. You can install from GitHub with this code. \n\n```bash\npip install git+https://github.com/business-science/pytimetk.git\n```\n\n",
"markdown": "---\ntitle: Install\ntoc: true\ntoc-depth: 3\nnumber-sections: true\nnumber-depth: 2\n---\n\n::: {.callout-warning collapse=\"false\"}\n## Under Development\n\nThis library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0. \n:::\n\n# Quick Install\n\nLet's get you up and running with `timetk` fast. You can install from GitHub with this code. \n\n```bash\npip install git+https://github.com/business-science/pytimetk.git\n```\n\n# Next steps\n\nCheck out the [Quick Start Guide Next.](/getting-started/02_quick_start.html)\n\n# More Coming Soon...\n\nWe are in the early stages of development. But it's obvious the potential for `timetk` now in Python. 🐍\n\n- Please [⭐ us on GitHub](https://github.com/business-science/pytimetk) (it takes 2-seconds and means a lot). \n- To make requests, please see our [Project Roadmap GH Issue #2](https://github.com/business-science/pytimetk/issues/2). You can make requests there. \n- Want to contribute? [See our contributing guide here.](/contributing.html) \n\n",
"supporting": [
"01_installation_files"
],
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/_freeze/guides/04_wrangling/execute-results/html.json

Large diffs are not rendered by default.

19 changes: 17 additions & 2 deletions docs/_site/getting-started/01_installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ <h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#quick-install" id="toc-quick-install" class="nav-link active" data-scroll-target="#quick-install"><span class="header-section-number">1</span> Quick Install</a></li>
<li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps"><span class="header-section-number">2</span> Next steps</a></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">3</span> More Coming Soon…</a></li>
</ul>
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/business-science/pytimetk/edit/main/getting-started/01_installation.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/business-science/pytimetk/issues" class="toc-action">Report an issue</a></p></div></div></nav>
</div>
Expand Down Expand Up @@ -347,10 +349,23 @@ <h1 class="title">Install</h1>
</div>
</div>
</div>
<section id="quick-install" class="level2" data-number="1">
<h2 data-number="1" class="anchored" data-anchor-id="quick-install"><span class="header-section-number">1</span> Quick Install</h2>
<section id="quick-install" class="level1" data-number="1">
<h1 data-number="1"><span class="header-section-number">1</span> Quick Install</h1>
<p>Let’s get you up and running with <code>timetk</code> fast. You can install from GitHub with this code.</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install git+https://github.com/business-science/pytimetk.git</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="next-steps" class="level1" data-number="2">
<h1 data-number="2"><span class="header-section-number">2</span> Next steps</h1>
<p>Check out the <a href="../getting-started/02_quick_start.html">Quick Start Guide Next.</a></p>
</section>
<section id="more-coming-soon" class="level1" data-number="3">
<h1 data-number="3"><span class="header-section-number">3</span> More Coming Soon…</h1>
<p>We are in the early stages of development. But it’s obvious the potential for <code>timetk</code> now in Python. 🐍</p>
<ul>
<li>Please <a href="https://github.com/business-science/pytimetk">⭐ us on GitHub</a> (it takes 2-seconds and means a lot).</li>
<li>To make requests, please see our <a href="https://github.com/business-science/pytimetk/issues/2">Project Roadmap GH Issue #2</a>. You can make requests there.</li>
<li>Want to contribute? <a href="../contributing.html">See our contributing guide here.</a></li>
</ul>


</section>
Expand Down
26 changes: 18 additions & 8 deletions docs/_site/getting-started/02_quick_start.html

Large diffs are not rendered by default.

67 changes: 32 additions & 35 deletions docs/_site/guides/01_visualization.html

Large diffs are not rendered by default.

13 changes: 9 additions & 4 deletions docs/_site/guides/02_timetk_concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,8 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#the-get-time-series-signature-function" id="toc-the-get-time-series-signature-function" class="nav-link" data-scroll-target="#the-get-time-series-signature-function">The Get Time Series Signature Function</a></li>
</ul></li>
</ul></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">3</span> More Coming Soon…</a></li>
<li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps"><span class="header-section-number">3</span> Next steps</a></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">4</span> More Coming Soon…</a></li>
</ul>
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/business-science/pytimetk/edit/main/guides/02_timetk_concepts.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/business-science/pytimetk/issues" class="toc-action">Report an issue</a></p></div></div></nav>
</div>
Expand Down Expand Up @@ -2848,11 +2849,15 @@ <h3 class="anchored" data-anchor-id="the-get-time-series-signature-function">The
</section>
</section>
</section>
<section id="more-coming-soon" class="level1" data-number="3">
<h1 data-number="3"><span class="header-section-number">3</span> More Coming Soon…</h1>
<section id="next-steps" class="level1" data-number="3">
<h1 data-number="3"><span class="header-section-number">3</span> Next steps</h1>
<p>Check out the <a href="../guides/03_pandas_frequency.html">Pandas Frequency Guide next.</a></p>
</section>
<section id="more-coming-soon" class="level1" data-number="4">
<h1 data-number="4"><span class="header-section-number">4</span> More Coming Soon…</h1>
<p>We are in the early stages of development. But it’s obvious the potential for <code>timetk</code> now in Python. 🐍</p>
<ul>
<li>Please ⭐ us on GitHub (it takes 2-seconds and means a lot).</li>
<li>Please <a href="https://github.com/business-science/pytimetk">⭐ us on GitHub</a> (it takes 2-seconds and means a lot).</li>
<li>To make requests, please see our <a href="https://github.com/business-science/pytimetk/issues/2">Project Roadmap GH Issue #2</a>. You can make requests there.</li>
<li>Want to contribute? <a href="../contributing.html">See our contributing guide here.</a></li>
</ul>
Expand Down
13 changes: 9 additions & 4 deletions docs/_site/guides/03_pandas_frequency.html
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,8 @@ <h2 id="toc-title">On this page</h2>
<ul class="collapse">
<li><a href="#example-padding-dates" id="toc-example-padding-dates" class="nav-link" data-scroll-target="#example-padding-dates">Example: Padding Dates</a></li>
</ul></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">3</span> More Coming Soon…</a></li>
<li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps"><span class="header-section-number">3</span> Next Steps</a></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">4</span> More Coming Soon…</a></li>
</ul>
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/business-science/pytimetk/edit/main/guides/03_pandas_frequency.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/business-science/pytimetk/issues" class="toc-action">Report an issue</a></p></div></div></nav>
</div>
Expand Down Expand Up @@ -639,11 +640,15 @@ <h3 class="anchored" data-anchor-id="example-padding-dates">Example: Padding Dat
<p>You’ll see these pandas frequencies come up as the parameter <code>freq</code> in many <code>timetk</code> functions.</p>
</section>
</section>
<section id="more-coming-soon" class="level1" data-number="3">
<h1 data-number="3"><span class="header-section-number">3</span> More Coming Soon…</h1>
<section id="next-steps" class="level1" data-number="3">
<h1 data-number="3"><span class="header-section-number">3</span> Next Steps</h1>
<p>Check out the <a href="../guides/04_wrangling.html">Data Wrangling Guide next.</a></p>
</section>
<section id="more-coming-soon" class="level1" data-number="4">
<h1 data-number="4"><span class="header-section-number">4</span> More Coming Soon…</h1>
<p>We are in the early stages of development. But it’s obvious the potential for <code>timetk</code> now in Python. 🐍</p>
<ul>
<li>Please ⭐ us on GitHub (it takes 2-seconds and means a lot).</li>
<li>Please <a href="https://github.com/business-science/pytimetk">⭐ us on GitHub</a> (it takes 2-seconds and means a lot).</li>
<li>To make requests, please see our <a href="https://github.com/business-science/pytimetk/issues/2">Project Roadmap GH Issue #2</a>. You can make requests there.</li>
<li>Want to contribute? <a href="../contributing.html">See our contributing guide here.</a></li>
</ul>
Expand Down
13 changes: 9 additions & 4 deletions docs/_site/guides/04_wrangling.html
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,8 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#basic-example-2" id="toc-basic-example-2" class="nav-link" data-scroll-target="#basic-example-2"><span class="header-section-number">3.1</span> Basic Example</a></li>
<li><a href="#pad-by-time-with-grouped-time-series" id="toc-pad-by-time-with-grouped-time-series" class="nav-link" data-scroll-target="#pad-by-time-with-grouped-time-series"><span class="header-section-number">3.2</span> Pad by Time with Grouped Time Series</a></li>
</ul></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">4</span> More Coming Soon…</a></li>
<li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps"><span class="header-section-number">4</span> Next Steps</a></li>
<li><a href="#more-coming-soon" id="toc-more-coming-soon" class="nav-link" data-scroll-target="#more-coming-soon"><span class="header-section-number">5</span> More Coming Soon…</a></li>
</ul>
<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/business-science/pytimetk/edit/main/guides/04_wrangling.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/business-science/pytimetk/issues" class="toc-action">Report an issue</a></p></div></div></nav>
</div>
Expand Down Expand Up @@ -1617,11 +1618,15 @@ <h2 data-number="3.2" class="anchored" data-anchor-id="pad-by-time-with-grouped-
</div>
</section>
</section>
<section id="more-coming-soon" class="level1" data-number="4">
<h1 data-number="4"><span class="header-section-number">4</span> More Coming Soon…</h1>
<section id="next-steps" class="level1" data-number="4">
<h1 data-number="4"><span class="header-section-number">4</span> Next Steps</h1>
<p>Check out the <a href="../guides/05_augmenting.html">Adding Features (Augmenting) Time Series Data Guide next.</a></p>
</section>
<section id="more-coming-soon" class="level1" data-number="5">
<h1 data-number="5"><span class="header-section-number">5</span> More Coming Soon…</h1>
<p>We are in the early stages of development. But it’s obvious the potential for <code>timetk</code> now in Python. 🐍</p>
<ul>
<li>Please ⭐ us on GitHub (it takes 2-seconds and means a lot).</li>
<li>Please <a href="https://github.com/business-science/pytimetk">⭐ us on GitHub</a> (it takes 2-seconds and means a lot).</li>
<li>To make requests, please see our <a href="https://github.com/business-science/pytimetk/issues/2">Project Roadmap GH Issue #2</a>. You can make requests there.</li>
<li>Want to contribute? <a href="../contributing.html">See our contributing guide here.</a></li>
</ul>
Expand Down
Loading

0 comments on commit 9438d5e

Please sign in to comment.