Script Documentation... it is all in the docs

DanPatterson_Retired

Help.... Documentation

Last thing written... if ever... First thing needed.

I have been messing with formatting my code using numpy doc strings

• A guide to NumPy/SciPy Documentation
• Example from GitHub

Code documentation.... the view on the left is within the script IDE and the view on the right is what is will look like when viewing a script's help.  Fancy... fancy...

And! Not only that, your favorite Python Package Manager includes it in their python distribution so Sphinx can use it.

So here is a little 'dirr' function I wrote since dir(object) returns a messy hard to read output in any form.

Here is the documentation for the function.

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">dirr</SPAN><SPAN class="punctuation token">(</SPAN>obj<SPAN class="punctuation token">,</SPAN> colwise<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> cols<SPAN class="operator token">=</SPAN><SPAN class="number token">3</SPAN><SPAN class="punctuation token">,</SPAN> sub<SPAN class="operator token">=</SPAN>None<SPAN class="punctuation token">,</SPAN> prn<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""</SPAN>"A formatted dir listing of a module <SPAN class="operator token">or</SPAN> function<SPAN class="punctuation token">.</SPAN>

&nbsp;&nbsp;&nbsp; Source <SPAN class="punctuation token">:</SPAN> arraytools module <SPAN class="keyword token">in</SPAN> tools<SPAN class="punctuation token">.</SPAN>py<SPAN class="punctuation token">,</SPAN> dirr <SPAN class="keyword token">def</SPAN>

&nbsp;&nbsp;&nbsp; Return a directory listing of a module's namespace <SPAN class="operator token">or</SPAN> a part of it <SPAN class="keyword token">if</SPAN> the
&nbsp;&nbsp;&nbsp; `sub` option <SPAN class="keyword token">is</SPAN> specified<SPAN class="punctuation token">.</SPAN>&nbsp; If&nbsp; `prn<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN>`<SPAN class="punctuation token">,</SPAN> then it <SPAN class="keyword token">is</SPAN> simply printed<SPAN class="punctuation token">.</SPAN> If
&nbsp;&nbsp;&nbsp; <SPAN class="token boolean">False</SPAN><SPAN class="punctuation token">,</SPAN> then the string <SPAN class="keyword token">is</SPAN> returned<SPAN class="punctuation token">.</SPAN>

&nbsp;&nbsp;&nbsp; Parameters
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN> colwise <SPAN class="punctuation token">:</SPAN> `<SPAN class="token boolean">True</SPAN>` <SPAN class="operator token">or</SPAN> `<SPAN class="number token">1</SPAN>`<SPAN class="punctuation token">,</SPAN> otherwise<SPAN class="punctuation token">,</SPAN> `<SPAN class="token boolean">False</SPAN>` <SPAN class="operator token">or</SPAN> `<SPAN class="number token">0</SPAN>`
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN> cols <SPAN class="punctuation token">:</SPAN> pick a size to suit
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN> sub <SPAN class="punctuation token">:</SPAN> sub<SPAN class="operator token">=</SPAN><SPAN class="string token">'a'</SPAN> all modules beginning <SPAN class="keyword token">with</SPAN> `a`
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN> prn <SPAN class="punctuation token">:</SPAN> `<SPAN class="token boolean">True</SPAN>` <SPAN class="keyword token">for</SPAN> <SPAN class="keyword token">print</SPAN> <SPAN class="operator token">or</SPAN> `<SPAN class="token boolean">False</SPAN>` to <SPAN class="keyword token">return</SPAN> output <SPAN class="keyword token">as</SPAN> string

&nbsp;&nbsp;&nbsp; Notes
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN>

&nbsp;&nbsp;&nbsp; See the `inspect` module <SPAN class="keyword token">for</SPAN> possible additions like `isfunction`<SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp; 'ismethod`<SPAN class="punctuation token">,</SPAN> `ismodule`

&nbsp;&nbsp;&nbsp; <SPAN class="operator token">**</SPAN>Examples<SPAN class="operator token">**</SPAN><SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">:</SPAN>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; dirr<SPAN class="punctuation token">(</SPAN>art<SPAN class="punctuation token">,</SPAN> colwise<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> cols<SPAN class="operator token">=</SPAN><SPAN class="number token">3</SPAN><SPAN class="punctuation token">,</SPAN> sub<SPAN class="operator token">=</SPAN>None<SPAN class="punctuation token">,</SPAN> prn<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp; <SPAN class="comment token"># all columnwise</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; dirr<SPAN class="punctuation token">(</SPAN>art<SPAN class="punctuation token">,</SPAN> colwise<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> cols<SPAN class="operator token">=</SPAN><SPAN class="number token">3</SPAN><SPAN class="punctuation token">,</SPAN> sub<SPAN class="operator token">=</SPAN><SPAN class="string token">'arr'</SPAN><SPAN class="punctuation token">,</SPAN> prn<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="comment token"># just the `arr`'s</SPAN>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">001</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; _arr_common&nbsp;&nbsp;&nbsp;&nbsp; arr2xyz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_json
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">002</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; arr_pnts&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_polygon_fc&nbsp; arr_polyline_fc
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">003</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; array2raster&nbsp;&nbsp;&nbsp; array_fc
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">004</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; array_struct&nbsp;&nbsp;&nbsp; arrays_cols
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""</SPAN>"‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

The key (apparently) is indentation, back-ticks and little tricks. 

In Spyder's help documentation, it looks like this. ( More on Spyder as an IDE for your work )

You can produce whole documentation for your modules or even single 'scripts' to accompany your code.

And the function itself makes finding my own documentation easier

Sample output

<SPAN class="comment token"># ---- by column</SPAN> dirr<SPAN class="punctuation token">(</SPAN>art<SPAN class="punctuation token">,</SPAN> colwise<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN> cols<SPAN class="operator token">=</SPAN><SPAN class="number token">4</SPAN><SPAN class="punctuation token">,</SPAN> sub<SPAN class="operator token">=</SPAN><SPAN class="string token">'arr'</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN> <SPAN class="operator token">|</SPAN> dir<SPAN class="punctuation token">(</SPAN>arraytools<SPAN class="punctuation token">)</SPAN> <SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN> <SPAN class="operator token">|</SPAN>&nbsp;&nbsp;&nbsp; <SPAN class="operator token"><</SPAN>module <SPAN class="string token">'arraytools'</SPAN> <SPAN class="keyword token">from</SPAN> <SPAN class="string token">'C:\\Git_Dan\\arraytools\\__init__.py'</SPAN><SPAN class="operator token">></SPAN> <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN> &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">001</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; _arr_common&nbsp;&nbsp;&nbsp;&nbsp; arr_pnts&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; array2raster&nbsp;&nbsp;&nbsp; array_struct&nbsp;&nbsp;&nbsp; &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">002</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; arr2xyz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_polygon_fc&nbsp; array_fc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arrays_cols&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">003</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; arr_json&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_polyline_fc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token"># ---- by row</SPAN> dirr<SPAN class="punctuation token">(</SPAN>art<SPAN class="punctuation token">,</SPAN> colwise<SPAN class="operator token">=</SPAN><SPAN class="token boolean">False</SPAN><SPAN class="punctuation token">,</SPAN> cols<SPAN class="operator token">=</SPAN><SPAN class="number token">4</SPAN><SPAN class="punctuation token">,</SPAN> sub<SPAN class="operator token">=</SPAN><SPAN class="string token">'arr'</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN> <SPAN class="operator token">|</SPAN> dir<SPAN class="punctuation token">(</SPAN>arraytools<SPAN class="punctuation token">)</SPAN> <SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN> <SPAN class="operator token">|</SPAN>&nbsp;&nbsp;&nbsp; <SPAN class="operator token"><</SPAN>module <SPAN class="string token">'arraytools'</SPAN> <SPAN class="keyword token">from</SPAN> <SPAN class="string token">'C:\\Git_Dan\\arraytools\\__init__.py'</SPAN><SPAN class="operator token">></SPAN> <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN> &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">001</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; _arr_common&nbsp;&nbsp;&nbsp;&nbsp; arr2xyz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_json&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arr_pnts&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">002</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; arr_polygon_fc&nbsp; arr_polyline_fc array2raster&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; <SPAN class="punctuation token">(</SPAN><SPAN class="number token">003</SPAN><SPAN class="punctuation token">)</SPAN>&nbsp;&nbsp;&nbsp; array_fc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; array_struct&nbsp;&nbsp;&nbsp; arrays_cols&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token"># ---- standard method</SPAN> dir<SPAN class="punctuation token">(</SPAN>art<SPAN class="punctuation token">)</SPAN> <SPAN class="punctuation token">[</SPAN><SPAN class="string token">'__all__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__args'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__art_modules__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__art_version__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__builtins__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__cached__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__doc__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__file__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__loader__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__name__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__package__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__path__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'__spec__'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_arr_common'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_center'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_centroid'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_common'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_convert'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_cursor_array'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_demo_frmt'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_demo_ma'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_demo_rec'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_densify_2D'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_describe'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_even_odd'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_extent'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_flat_'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_func'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_geo_array'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_get_shapes'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_help'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_id_geom_array'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_max'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_min'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_ndarray'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_new_view_'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_pad_'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_pad_even_odd'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_pad_nan'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_pad_zero'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_props'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_reshape_'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_split_array'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_two_arrays'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_unpack'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_view_'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_xy'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_xyID'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'_xy_idx'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'a_filter'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'a_io'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'all_folders'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'analysis'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'angle_2pnts'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'angle_np'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'angle_seq'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'angles_poly'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'apt'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arc_np'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'areas'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arr2xyz'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arr_json'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arr_pnts'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arr_polygon_fc'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arr_polyline_fc'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'array2raster'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'array_fc'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'array_struct'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'arrays_cols'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'azim_np'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'block'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'block_arr'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'centers'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'centroids'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'change_arr'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'change_fld'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'circle'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN> snip‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Producing links to web links

This may be a bit much, but your documentation can also provide links to http: sites to reference specific web pages from within your documentation.  Here is an example.  The key is to provide a

• link number ... [1]
• a name for the link... with trailing __
• and the actual link itself.

Web links in script documentation

References<SPAN class="punctuation token">:</SPAN> <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN> <SPAN class="operator token">**</SPAN>creating meshgrids <SPAN class="keyword token">from</SPAN> x<SPAN class="punctuation token">,</SPAN>y data <SPAN class="operator token">and</SPAN> plotting<SPAN class="operator token">**</SPAN> <SPAN class="punctuation token">[</SPAN><SPAN class="number token">1</SPAN><SPAN class="punctuation token">]</SPAN> `<SPAN class="number token">2D</SPAN> array of values based on coordinates`__<SPAN class="punctuation token">:</SPAN> __ http<SPAN class="punctuation token">:</SPAN><SPAN class="operator token">//</SPAN>stackoverflow<SPAN class="punctuation token">.</SPAN>com<SPAN class="operator token">/</SPAN>questions<SPAN class="operator token">/</SPAN><SPAN class="number token">30764955</SPAN><SPAN class="operator token">/</SPAN>python<SPAN class="operator token">-</SPAN>numpy<SPAN class="operator token">-</SPAN>create<SPAN class="operator token">-</SPAN>2darray<SPAN class="operator token">-</SPAN>of<SPAN class="operator token">-</SPAN>values<SPAN class="operator token">-</SPAN>based<SPAN class="operator token">-</SPAN>on<SPAN class="operator token">-</SPAN>coordinates <SPAN class="punctuation token">[</SPAN><SPAN class="number token">2</SPAN><SPAN class="punctuation token">]</SPAN> `<SPAN class="number token">2D</SPAN> histogram issues`__<SPAN class="punctuation token">:</SPAN> __ https<SPAN class="punctuation token">:</SPAN><SPAN class="operator token">//</SPAN>github<SPAN class="punctuation token">.</SPAN>com<SPAN class="operator token">/</SPAN>numpy<SPAN class="operator token">/</SPAN>numpy<SPAN class="operator token">/</SPAN>issues<SPAN class="operator token">/</SPAN><SPAN class="number token">7317</SPAN> <SPAN class="operator token">**</SPAN>distance calculations <SPAN class="operator token">and</SPAN> related<SPAN class="operator token">**</SPAN> <SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN> <SPAN class="punctuation token">(</SPAN>scipy<SPAN class="punctuation token">,</SPAN> skikit<SPAN class="operator token">-</SPAN>learn<SPAN class="punctuation token">)</SPAN> ‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

The **text** provides bold highlighting.  The [1] on line 6, is the first link with line 7 being the link name in back-tics and trailing __.  Line 9, with the leading __ is the actual link itself.  What is show is a snip of the whole link list shown below.

Simpler option

You might need a simpler documentation example

&nbsp;&nbsp;&nbsp; References<SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN><SPAN class="operator token">-</SPAN>

&nbsp;&nbsp;&nbsp; `<SPAN class="operator token"><</SPAN>https<SPAN class="punctuation token">:</SPAN><SPAN class="operator token">//</SPAN>stackoverflow<SPAN class="punctuation token">.</SPAN>com<SPAN class="operator token">/</SPAN>questions<SPAN class="operator token">/</SPAN><SPAN class="number token">7352684</SPAN><SPAN class="operator token">/</SPAN>how<SPAN class="operator token">-</SPAN>to<SPAN class="operator token">-</SPAN>find<SPAN class="operator token">-</SPAN>the<SPAN class="operator token">-</SPAN>groups<SPAN class="operator token">-</SPAN>of<SPAN class="operator token">-</SPAN>
&nbsp;&nbsp;&nbsp; sequences<SPAN class="operator token">-</SPAN>elements<SPAN class="operator token">-</SPAN><SPAN class="keyword token">from</SPAN><SPAN class="operator token">-</SPAN>an<SPAN class="operator token">-</SPAN>array<SPAN class="operator token">-</SPAN><SPAN class="keyword token">in</SPAN><SPAN class="operator token">-</SPAN>numpy<SPAN class="operator token">></SPAN>`_<SPAN class="punctuation token">.</SPAN>

&nbsp;&nbsp;&nbsp; `<SPAN class="operator token"><</SPAN>https<SPAN class="punctuation token">:</SPAN><SPAN class="operator token">//</SPAN>stackoverflow<SPAN class="punctuation token">.</SPAN>com<SPAN class="operator token">/</SPAN>questions<SPAN class="operator token">/</SPAN><SPAN class="number token">50551776</SPAN><SPAN class="operator token">/</SPAN>python<SPAN class="operator token">-</SPAN>chunk<SPAN class="operator token">-</SPAN>array<SPAN class="operator token">-</SPAN>on<SPAN class="operator token">-</SPAN>
&nbsp;&nbsp;&nbsp; condition<SPAN class="comment token">#50551924>`_.‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

This consists of `< at the start and >`_. at the end with the link in between.  This yields...

Finally

Remember, documentation is important. If not for yourself, for someone else.

SimonKettle

Ha ha..."Last thing written... if ever... First thing needed." So true!