Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lambdamusic
lambdamusic committed Jul 1, 2022
1 parent 6e9636f commit 8f72165
Show file tree
Hide file tree
Showing 18 changed files with 1,287 additions and 320 deletions.
4 changes: 4 additions & 0 deletions dimcli/jupyter/magics.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,16 @@ def dsldf(self, line, cell=None):
Can be used as a single-line (``%dsldf``) or multi-line (``%%dsldf``) command. Requires an authenticated API session. If used as a multi-line command, a variable name can be specified as the first argument. Otherwise, the results are saved to a variable called ``dsl_last_results``.
Flags:
``--links`` => style the dataframe with links to the original data sources.
``--nice`` => break down complex structures into strings (EXPERIMENTAL).
Parameters
----------
line: str
A valid DSL search query, or, for multiline commands, a parameter name and/or formatting flags.
cell: str
A valid DSL search query.
Returns
Expand Down
144 changes: 21 additions & 123 deletions docs/_modules/dimcli/__init__.html
View file
Original file line number Diff line number Diff line change
@@ -1,152 +1,69 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dimcli.__init__ &mdash; DimCli documentation</title>



<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />







<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->


<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>

<script type="text/javascript" src="../../_static/js/theme.js"></script>


<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>

<body class="wy-body-for-nav">


<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> DimCli



<a href="../../index.html" class="icon icon-home"> DimCli
</a>







<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>


<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<p class="caption"><span class="caption-text">Contents</span></p>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting-started.html">Getting Started with Dimcli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">Modules Reference</a></li>
</ul>



</div>

</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">DimCli</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">

<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>

<li><a href="../index.html">Module code</a> &raquo;</li>

<li>dimcli.__init__</li>


<li class="wy-breadcrumbs-aside">

</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for dimcli.__init__</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Dimcli utilities for logging in/out of the Dimensions API. </span>
Expand Down Expand Up @@ -339,49 +256,30 @@ <h1>Source code for dimcli.__init__</h1><div class="highlight"><pre>
</pre></div>

</div>

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2020-2021, Digital Science

</p>
<p>&#169; Copyright 2020-2021, Digital Science.</p>
</div>



Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>

</section>

</div>


<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>





</script>

</body>
</html>
6 changes: 4 additions & 2 deletions docs/_modules/dimcli/core/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -790,7 +790,7 @@ <h1>Source code for dimcli.core.api</h1><div class="highlight"><pre>

<span class="c1"># Dataframe Methods </span>

<div class="viewcode-block" id="DslDataset.as_dataframe"><a class="viewcode-back" href="../../../modules.html#dimcli.core.api.DslDataset.as_dataframe">[docs]</a> <span class="k">def</span> <span class="nf">as_dataframe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">links</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<div class="viewcode-block" id="DslDataset.as_dataframe"><a class="viewcode-back" href="../../../modules.html#dimcli.core.api.DslDataset.as_dataframe">[docs]</a> <span class="k">def</span> <span class="nf">as_dataframe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">links</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">nice</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Return the JSON data as a Pandas DataFrame. </span>

<span class="sd"> If `key` is empty, the first available JSON key (eg &#39;publications&#39;) is used to determine</span>
Expand All @@ -802,6 +802,8 @@ <h1>Source code for dimcli.core.api</h1><div class="highlight"><pre>
<span class="sd"> The JSON results data object that needs to be processed.</span>
<span class="sd"> links: bool, optional </span>
<span class="sd"> Tranform suitable fields to hyperlinks. Default: False.</span>
<span class="sd"> nice: bool, optional </span>
<span class="sd"> Reformat column names and complex values where possible. Useful for visual inspection and printing our. Default: False.</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
Expand All @@ -815,7 +817,7 @@ <h1>Source code for dimcli.core.api</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;errors&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">df_factory</span><span class="o">.</span><span class="n">df_simple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">links</span><span class="p">)</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">df_factory</span><span class="o">.</span><span class="n">df_simple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">json</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">links</span><span class="p">,</span> <span class="n">nice</span><span class="p">)</span></div>


<div class="viewcode-block" id="DslDataset.as_dataframe_authors"><a class="viewcode-back" href="../../../modules.html#dimcli.core.api.DslDataset.as_dataframe_authors">[docs]</a> <span class="k">def</span> <span class="nf">as_dataframe_authors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">links</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
Expand Down
Loading

0 comments on commit 8f72165

Please sign in to comment.