updatedd documentation

igmk · Feb 16, 2024 · 275f5a5 · 275f5a5
1 parent 3d258b7
commit 275f5a5
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 17 deletions.
diff --git a/_modules/orbital_radar/radarspec.html b/_modules/orbital_radar/radarspec.html
@@ -451,7 +451,8 @@ <h1>Source code for orbital_radar.radarspec</h1><div class="highlight"><pre>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Calculates the radar wavelength from the radar frequency.</span>
 
-<span class="sd">        Units:</span>
+<span class="sd">        Units</span>
+<span class="sd">        -----</span>
 <span class="sd">        - frequency: radar frequency [Hz]</span>
 <span class="sd">        - wavelength: radar wavelength [m]</span>
 <span class="sd">        - speed of light: speed of light [m s-1]</span>

diff --git a/_modules/orbital_radar/readers/radar.html b/_modules/orbital_radar/readers/radar.html
@@ -108,17 +108,17 @@ <h1>Source code for orbital_radar.readers.radar</h1><div class="highlight"><pre>
 
 <span class="sd">    Implemented readers</span>
 <span class="sd">    -------------------</span>
-<span class="sd">    bco: Barbados Cloud Observatory, Barbados</span>
-<span class="sd">    jue: JOYCE, Juelich, Germany</span>
-<span class="sd">    mag: Magurele, Romania</span>
-<span class="sd">    min: Mindelo, Cape Verde</span>
-<span class="sd">    nor: Norunda, Sweden</span>
-<span class="sd">    nya: Ny-Alesund, Svalbard</span>
-<span class="sd">    mirac_p5: Polar 5, Mirac radar</span>
-<span class="sd">    rasta: Falcon, RASTA radar</span>
-<span class="sd">    arm: ARM sites</span>
-<span class="sd">    pamtra: PAMTRA simulations</span>
-<span class="sd">    cloudnet: cloudnet format</span>
+<span class="sd">    - bco: Barbados Cloud Observatory, Barbados</span>
+<span class="sd">    - jue: JOYCE, Juelich, Germany</span>
+<span class="sd">    - mag: Magurele, Romania</span>
+<span class="sd">    - min: Mindelo, Cape Verde</span>
+<span class="sd">    - nor: Norunda, Sweden</span>
+<span class="sd">    - nya: Ny-Alesund, Svalbard</span>
+<span class="sd">    - mirac_p5: Polar 5, Mirac radar</span>
+<span class="sd">    - rasta: Falcon, RASTA radar</span>
+<span class="sd">    - arm: ARM sites</span>
+<span class="sd">    - pamtra: PAMTRA simulations</span>
+<span class="sd">    - cloudnet: cloudnet format</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">date</span><span class="p">,</span> <span class="n">site_name</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">input_radar_format</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/api/radarspec.html b/api/radarspec.html
@@ -249,10 +249,6 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 <dt class="sig sig-object py" id="orbital_radar.radarspec.RadarBeam.calculate_wavelength">
 <span class="sig-name descname"><span class="pre">calculate_wavelength</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/orbital_radar/radarspec.html#RadarBeam.calculate_wavelength"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#orbital_radar.radarspec.RadarBeam.calculate_wavelength" title="Permalink to this definition">¶</a></dt>
 <dd><p>Calculates the radar wavelength from the radar frequency.</p>
-<p>Units:
-- frequency: radar frequency [Hz]
-- wavelength: radar wavelength [m]
-- speed of light: speed of light [m s-1]</p>
 </dd></dl>
 
 <dl class="py method">