Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Nov 7, 2024
1 parent b8f0ea4 commit 2c4a0a7
Show file tree
Hide file tree
Showing 26 changed files with 43 additions and 27 deletions.
2 changes: 1 addition & 1 deletion _modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/codecs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.codecs &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/combine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.combine &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/df.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.df &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/fits.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.fits &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
20 changes: 18 additions & 2 deletions _modules/kerchunk/grib2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.grib2 &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down Expand Up @@ -97,7 +97,17 @@ <h1>Source code for kerchunk.grib2</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">kerchunk.utils</span> <span class="kn">import</span> <span class="n">class_factory</span><span class="p">,</span> <span class="n">_encode_for_JSON</span>
<span class="kn">from</span> <span class="nn">kerchunk.codecs</span> <span class="kn">import</span> <span class="n">GRIBCodec</span>
<span class="kn">from</span> <span class="nn">kerchunk.combine</span> <span class="kn">import</span> <span class="n">MultiZarrToZarr</span><span class="p">,</span> <span class="n">drop</span>
<span class="kn">from</span> <span class="nn">kerchunk._grib_idx</span> <span class="kn">import</span> <span class="n">parse_grib_idx</span><span class="p">,</span> <span class="n">build_idx_grib_mapping</span><span class="p">,</span> <span class="n">map_from_index</span>
<span class="kn">from</span> <span class="nn">kerchunk._grib_idx</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">parse_grib_idx</span><span class="p">,</span>
<span class="n">build_idx_grib_mapping</span><span class="p">,</span>
<span class="n">map_from_index</span><span class="p">,</span>
<span class="n">strip_datavar_chunks</span><span class="p">,</span>
<span class="n">reinflate_grib_store</span><span class="p">,</span>
<span class="n">extract_datatree_chunk_index</span><span class="p">,</span>
<span class="n">AggregationType</span><span class="p">,</span>
<span class="n">read_store</span><span class="p">,</span>
<span class="n">write_store</span><span class="p">,</span>
<span class="p">)</span>


<span class="k">try</span><span class="p">:</span>
Expand Down Expand Up @@ -679,6 +689,12 @@ <h1>Source code for kerchunk.grib2</h1><div class="highlight"><pre>
<span class="s2">&quot;parse_grib_idx&quot;</span><span class="p">,</span>
<span class="s2">&quot;build_idx_grib_mapping&quot;</span><span class="p">,</span>
<span class="s2">&quot;map_from_index&quot;</span><span class="p">,</span>
<span class="s2">&quot;strip_datavar_chunks&quot;</span><span class="p">,</span>
<span class="s2">&quot;reinflate_grib_store&quot;</span><span class="p">,</span>
<span class="s2">&quot;extract_datatree_chunk_index&quot;</span><span class="p">,</span>
<span class="s2">&quot;AggregationType&quot;</span><span class="p">,</span>
<span class="s2">&quot;read_store&quot;</span><span class="p">,</span>
<span class="s2">&quot;write_store&quot;</span><span class="p">,</span>
<span class="p">]</span>
</pre></div>

Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/hdf.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.hdf &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/hdf4.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.hdf4 &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/netCDF3.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.netCDF3 &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/tiff.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.tiff &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _modules/kerchunk/utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk.utils &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="../../_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion _static/css/theme.css
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion advanced.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Advanced Topics &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion beyond.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Beyond Python &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion cases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Case studies &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion contributing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Contributing to kerchunk &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion detail.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Detailed description &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kerchunk &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion nonzarr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Non-zarr uses &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion reference_aggregation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Aggregation special cases &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion spec.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>References specification &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion test_example.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Quick Start &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down
2 changes: 1 addition & 1 deletion tutorial.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tutorial &mdash; kerchunk documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


<link rel="shortcut icon" href="_static/kerchunk.ico"/>
Expand Down

0 comments on commit 2c4a0a7

Please sign in to comment.