Skip to content

Commit 13382f2

Browse files
author
Jeff Whitaker
committed
update docs
1 parent 4254fd6 commit 13382f2

21 files changed

Lines changed: 112 additions & 271 deletions

‎docs/class-tree.html‎

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,15 @@
4646
</b></center><br />
4747
<h1 class="epydoc">Class Hierarchy</h1>
4848
<ul class="nomargin-top">
49-
<li> <strong class="uidlink"><a href="netcdftime.netcdftime.datetime-class.html">netcdftime.netcdftime.datetime</a></strong>:
50-
<em class="summary">Phony datetime object which mimics the python datetime object, but
51-
allows for dates that don't exist in the proleptic gregorian
52-
calendar.</em>
53-
</li>
54-
<li> <strong class="uidlink">object</strong>:
55-
<em class="summary">The most base type</em>
49+
<li> <strong class="uidlink"><a href="netCDF3.Dataset-class.html">netCDF3.Dataset</a></strong>:
50+
<em class="summary">Dataset(self, filename, mode=&quot;r&quot;, clobber=True,
51+
format='NETCDF3_64BIT')</em>
5652
<ul>
53+
<li> <strong class="uidlink"><a href="netCDF3.MFDataset-class.html">netCDF3.MFDataset</a></strong>:
54+
<em class="summary">MFDataset(self, files, check=False, exclude=[])</em>
55+
</li>
56+
</ul>
57+
</li>
5758
<li> <strong class="uidlink"><a href="netCDF4.Dataset-class.html">netCDF4.Dataset</a></strong>:
5859
<em class="summary">Dataset(self, filename, mode=&quot;r&quot;, clobber=True,
5960
format='NETCDF4')</em>
@@ -66,32 +67,26 @@ <h1 class="epydoc">Class Hierarchy</h1>
6667
</li>
6768
</ul>
6869
</li>
69-
<li> <strong class="uidlink"><a href="netCDF3.Dataset-class.html">netCDF3.Dataset</a></strong>:
70-
<em class="summary">Dataset(self, filename, mode=&quot;r&quot;, clobber=True,
71-
format='NETCDF3_64BIT')</em>
72-
<ul>
73-
<li> <strong class="uidlink"><a href="netCDF3.MFDataset-class.html">netCDF3.MFDataset</a></strong>:
74-
<em class="summary">MFDataset(self, files, check=False, exclude=[])</em>
75-
</li>
76-
</ul>
77-
</li>
7870
<li> <strong class="uidlink"><a href="netCDF4.Dimension-class.html">netCDF4.Dimension</a></strong>:
7971
<em class="summary">Dimension(self, group, name, size=None)</em>
8072
</li>
8173
<li> <strong class="uidlink"><a href="netCDF3.Dimension-class.html">netCDF3.Dimension</a></strong>:
8274
<em class="summary">Dimension(self, dset, name, size=None)</em>
8375
</li>
76+
<li> <strong class="uidlink"><a href="netCDF3.Variable-class.html">netCDF3.Variable</a></strong>:
77+
<em class="summary">Variable(self, dset, name, datatype, dimensions=(),
78+
fill_value=None)</em>
79+
</li>
8480
<li> <strong class="uidlink"><a href="netCDF4.Variable-class.html">netCDF4.Variable</a></strong>:
8581
<em class="summary">Variable(self, group, name, datatype, dimensions=(), zlib=False,
8682
complevel=6, shuffle=True, fletcher32=False, contiguous=False,
8783
chunksizes=None, endian='native',
8884
least_significant_digit=None,fill_value=None)</em>
8985
</li>
90-
<li> <strong class="uidlink"><a href="netCDF3.Variable-class.html">netCDF3.Variable</a></strong>:
91-
<em class="summary">Variable(self, dset, name, datatype, dimensions=(),
92-
fill_value=None)</em>
93-
</li>
94-
</ul>
86+
<li> <strong class="uidlink"><a href="netcdftime.netcdftime.datetime-class.html">netcdftime.netcdftime.datetime</a></strong>:
87+
<em class="summary">Phony datetime object which mimics the python datetime object, but
88+
allows for dates that don't exist in the proleptic gregorian
89+
calendar.</em>
9590
</li>
9691
<li> <strong class="uidlink"><a href="netcdftime.netcdftime.utime-class.html">netcdftime.netcdftime.utime</a></strong>:
9792
<em class="summary">Performs conversions of netCDF time coordinate data to/from
@@ -121,7 +116,8 @@ <h1 class="epydoc">Class Hierarchy</h1>
121116
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
122117
<tr>
123118
<td align="left" class="footer">
124-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
119+
Generated by Epydoc 3.0.1
120+
on Tue Dec 23 21:26:34 2008
125121
</td>
126122
<td align="right" class="footer">
127123
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/epydoc.css‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ table.summary a.summary-sig-name:visited
162162

163163
/* Subclass list
164164
*/
165-
ul.subclass-list { display: inline; }
166-
ul.subclass-list li { display: inline; }
165+
ul.subclass-list { display: inline; margin: 0; padding: 0; }
166+
ul.subclass-list li { display: inline; margin: 0; padding: 0; }
167167

168168
/* To render variables, classes etc. like functions */
169169
table.summary .summary-name { color: #006080; font-weight: bold;

‎docs/help.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,8 @@ <h2> The Navigation Bar </h2>
234234
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
235235
<tr>
236236
<td align="left" class="footer">
237-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
237+
Generated by Epydoc 3.0.1
238+
on Tue Dec 23 21:26:34 2008
238239
</td>
239240
<td align="right" class="footer">
240241
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/identifier-index.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,8 @@ <h1 class="epydoc">Identifier Index</h1>
655655
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
656656
<tr>
657657
<td align="left" class="footer">
658-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
658+
Generated by Epydoc 3.0.1
659+
on Tue Dec 23 21:26:34 2008
659660
</td>
660661
<td align="right" class="footer">
661662
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/index.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ <h1 class="epydoc">Module Hierarchy</h1>
7474
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
7575
<tr>
7676
<td align="left" class="footer">
77-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
77+
Generated by Epydoc 3.0.1
78+
on Tue Dec 23 21:26:34 2008
7879
</td>
7980
<td align="right" class="footer">
8081
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/module-tree.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ <h1 class="epydoc">Module Hierarchy</h1>
7474
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
7575
<tr>
7676
<td align="left" class="footer">
77-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
77+
Generated by Epydoc 3.0.1
78+
on Tue Dec 23 21:26:34 2008
7879
</td>
7980
<td align="right" class="footer">
8081
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/netCDF3-module.html‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ <h2 class="heading">7) Reading data from a multi-file netCDF dataset.</h2>
463463
PERFORMANCE OF THIS SOFTWARE.
464464
</p>
465465
<p><strong>Version:</strong>
466-
0.7.6
466+
0.7.7
467467
</p>
468468
</div><!-- ==================== CLASSES ==================== -->
469469
<a name="section-Classes"></a>
@@ -474,34 +474,26 @@ <h2 class="heading">7) Reading data from a multi-file netCDF dataset.</h2>
474474
<span class="table-header">Classes</span></td>
475475
</tr>
476476
<tr>
477-
<td width="15%" align="right" valign="top" class="summary">
478-
<span class="summary-type">&nbsp;</span>
479-
</td><td class="summary">
477+
<td class="summary" colspan="2">
480478
<a href="netCDF3.Dataset-class.html" class="summary-name">Dataset</a><br />
481479
Dataset(self, filename, mode=&quot;r&quot;, clobber=True,
482480
format='NETCDF3_64BIT')
483481
</td>
484482
</tr>
485483
<tr>
486-
<td width="15%" align="right" valign="top" class="summary">
487-
<span class="summary-type">&nbsp;</span>
488-
</td><td class="summary">
484+
<td class="summary" colspan="2">
489485
<a href="netCDF3.Dimension-class.html" class="summary-name">Dimension</a><br />
490486
Dimension(self, dset, name, size=None)
491487
</td>
492488
</tr>
493489
<tr>
494-
<td width="15%" align="right" valign="top" class="summary">
495-
<span class="summary-type">&nbsp;</span>
496-
</td><td class="summary">
490+
<td class="summary" colspan="2">
497491
<a href="netCDF3.MFDataset-class.html" class="summary-name">MFDataset</a><br />
498492
MFDataset(self, files, check=False, exclude=[])
499493
</td>
500494
</tr>
501495
<tr>
502-
<td width="15%" align="right" valign="top" class="summary">
503-
<span class="summary-type">&nbsp;</span>
504-
</td><td class="summary">
496+
<td class="summary" colspan="2">
505497
<a href="netCDF3.Variable-class.html" class="summary-name">Variable</a><br />
506498
Variable(self, dset, name, datatype, dimensions=(),
507499
fill_value=None)
@@ -867,7 +859,8 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">stringtochar</span>(
867859
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
868860
<tr>
869861
<td align="left" class="footer">
870-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:07 2008
862+
Generated by Epydoc 3.0.1
863+
on Tue Dec 23 21:26:34 2008
871864
</td>
872865
<td align="right" class="footer">
873866
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/netCDF3.Dataset-class.html‎

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
</td>
4646
</tr>
4747
</table>
48-
<!-- ==================== CLASS DESCRIPTION ==================== -->
49-
<h1 class="epydoc">Class Dataset</h1><p class="nomargin-top"></p>
48+
<!-- ==================== TYPE DESCRIPTION ==================== -->
49+
<h1 class="epydoc">type Dataset</h1><p class="nomargin-top"></p>
5050
<pre class="base-tree">
5151
object --+
5252
|
@@ -392,17 +392,6 @@ <h1 class="epydoc">Class Dataset</h1><p class="nomargin-top"></p>
392392

393393
</td>
394394
</tr>
395-
<tr>
396-
<td colspan="2" class="summary">
397-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
398-
<code>__hash__</code>,
399-
<code>__reduce__</code>,
400-
<code>__reduce_ex__</code>,
401-
<code>__repr__</code>,
402-
<code>__str__</code>
403-
</p>
404-
</td>
405-
</tr>
406395
</table>
407396
<!-- ==================== INSTANCE VARIABLES ==================== -->
408397
<a name="section-InstanceVariables"></a>
@@ -460,13 +449,6 @@ <h1 class="epydoc">Class Dataset</h1><p class="nomargin-top"></p>
460449
<a name="maskanscale"></a><span class="summary-name">maskanscale</span>
461450
</td>
462451
</tr>
463-
<tr>
464-
<td colspan="2" class="summary">
465-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
466-
<code>__class__</code>
467-
</p>
468-
</td>
469-
</tr>
470452
</table>
471453
<!-- ==================== METHOD DETAILS ==================== -->
472454
<a name="section-MethodDetails"></a>
@@ -766,7 +748,8 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">set_fill_on</span>(<
766748
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
767749
<tr>
768750
<td align="left" class="footer">
769-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:08 2008
751+
Generated by Epydoc 3.0.1
752+
on Tue Dec 23 21:26:35 2008
770753
</td>
771754
<td align="right" class="footer">
772755
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/netCDF3.Dimension-class.html‎

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
</td>
4646
</tr>
4747
</table>
48-
<!-- ==================== CLASS DESCRIPTION ==================== -->
49-
<h1 class="epydoc">Class Dimension</h1><p class="nomargin-top"></p>
48+
<!-- ==================== TYPE DESCRIPTION ==================== -->
49+
<h1 class="epydoc">type Dimension</h1><p class="nomargin-top"></p>
5050
<pre class="base-tree">
5151
object --+
5252
|
@@ -165,36 +165,6 @@ <h1 class="epydoc">Class Dimension</h1><p class="nomargin-top"></p>
165165

166166
</td>
167167
</tr>
168-
<tr>
169-
<td colspan="2" class="summary">
170-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
171-
<code>__delattr__</code>,
172-
<code>__getattribute__</code>,
173-
<code>__hash__</code>,
174-
<code>__reduce__</code>,
175-
<code>__reduce_ex__</code>,
176-
<code>__repr__</code>,
177-
<code>__setattr__</code>,
178-
<code>__str__</code>
179-
</p>
180-
</td>
181-
</tr>
182-
</table>
183-
<!-- ==================== PROPERTIES ==================== -->
184-
<a name="section-Properties"></a>
185-
<table class="summary" border="1" cellpadding="3"
186-
cellspacing="0" width="100%" bgcolor="white">
187-
<tr bgcolor="#70b0f0" class="table-header">
188-
<td align="left" colspan="2" class="table-header">
189-
<span class="table-header">Properties</span></td>
190-
</tr>
191-
<tr>
192-
<td colspan="2" class="summary">
193-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
194-
<code>__class__</code>
195-
</p>
196-
</td>
197-
</tr>
198168
</table>
199169
<!-- ==================== METHOD DETAILS ==================== -->
200170
<a name="section-MethodDetails"></a>
@@ -281,7 +251,8 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span
281251
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
282252
<tr>
283253
<td align="left" class="footer">
284-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:08 2008
254+
Generated by Epydoc 3.0.1
255+
on Tue Dec 23 21:26:35 2008
285256
</td>
286257
<td align="right" class="footer">
287258
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/netCDF3.MFDataset-class.html‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
</td>
4646
</tr>
4747
</table>
48-
<!-- ==================== CLASS DESCRIPTION ==================== -->
49-
<h1 class="epydoc">Class MFDataset</h1><p class="nomargin-top"></p>
48+
<!-- ==================== TYPE DESCRIPTION ==================== -->
49+
<h1 class="epydoc">type MFDataset</h1><p class="nomargin-top"></p>
5050
<pre class="base-tree">
5151
object --+
5252
|
@@ -192,13 +192,6 @@ <h1 class="epydoc">Class MFDataset</h1><p class="nomargin-top"></p>
192192
<code><a href="netCDF3.Dataset-class.html#set_fill_on">set_fill_on</a></code>,
193193
<code><a href="netCDF3.Dataset-class.html#sync">sync</a></code>
194194
</p>
195-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
196-
<code>__hash__</code>,
197-
<code>__reduce__</code>,
198-
<code>__reduce_ex__</code>,
199-
<code>__repr__</code>,
200-
<code>__str__</code>
201-
</p>
202195
</td>
203196
</tr>
204197
</table>
@@ -233,9 +226,6 @@ <h1 class="epydoc">Class MFDataset</h1><p class="nomargin-top"></p>
233226
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="netCDF3.Dataset-class.html">Dataset</a></code></b>:
234227
<code><a href="netCDF3.Dataset-class.html#maskanscale">maskanscale</a></code>
235228
</p>
236-
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
237-
<code>__class__</code>
238-
</p>
239229
</td>
240230
</tr>
241231
</table>
@@ -265,7 +255,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__getattribute__</sp
265255
<p>x.__getattribute__('name') &lt;==&gt; x.name</p>
266256
<dl class="fields">
267257
<dt>Overrides:
268-
object.__getattribute__
258+
<a href="netCDF3.Dataset-class.html#__getattribute__">Dataset.__getattribute__</a>
269259
<dd><em class="note">(inherited documentation)</em></dd>
270260
</dt>
271261
</dl>
@@ -311,7 +301,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>()</s
311301
an empty list.</li>
312302
</ul></dd>
313303
<dt>Overrides:
314-
object.__init__
304+
<a href="netCDF3.Dataset-class.html#__init__">Dataset.__init__</a>
315305
</dt>
316306
</dl>
317307
</td></tr></table>
@@ -333,7 +323,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__setattr__</span>(<
333323
<p>override base class attribute creation</p>
334324
<dl class="fields">
335325
<dt>Overrides:
336-
object.__setattr__
326+
<a href="netCDF3.Dataset-class.html#__setattr__">Dataset.__setattr__</a>
337327
</dt>
338328
</dl>
339329
</td></tr></table>
@@ -409,7 +399,8 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">ncattrs</span>(<span
409399
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
410400
<tr>
411401
<td align="left" class="footer">
412-
Generated by Epydoc 3.0.1 on Mon Sep 22 09:44:08 2008
402+
Generated by Epydoc 3.0.1
403+
on Tue Dec 23 21:26:35 2008
413404
</td>
414405
<td align="right" class="footer">
415406
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)