Skip to content

Commit 0737519

Browse files
committed
Generated documentation for cli_lib.
1 parent 3f12a17 commit 0737519

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1602
-778
lines changed

docs-gen/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
77
EXTRACT_ALL = YES
88
EXTRACT_PRIVATE = YES
99
HIDE_SCOPE_NAMES = YES
10-
INPUT = src ../lib
10+
INPUT = src ../lib ../cli_lib
1111
USE_MDFILE_AS_MAINPAGE = README.md
1212
RECURSIVE = YES
1313
EXAMPLE_PATTERNS = *
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Practical Astronomy: /home/jimc/projects/practical-astronomy-python/cli_lib Directory Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">Practical Astronomy
29+
</div>
30+
</td>
31+
</tr>
32+
</tbody>
33+
</table>
34+
</div>
35+
<!-- end header part -->
36+
<!-- Generated by Doxygen 1.8.17 -->
37+
<script type="text/javascript">
38+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
39+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
40+
/* @license-end */
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
46+
$(function() {
47+
initMenu('',true,false,'search.php','Search');
48+
$(document).ready(function() { init_search(); });
49+
});
50+
/* @license-end */</script>
51+
<div id="main-nav"></div>
52+
</div><!-- top -->
53+
<div id="side-nav" class="ui-resizable side-nav-resizable">
54+
<div id="nav-tree">
55+
<div id="nav-tree-contents">
56+
<div id="nav-sync" class="sync"></div>
57+
</div>
58+
</div>
59+
<div id="splitbar" style="-moz-user-select:none;"
60+
class="ui-resizable-handle">
61+
</div>
62+
</div>
63+
<script type="text/javascript">
64+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
65+
$(document).ready(function(){initNavTree('dir_3e90ebb34b98c37ddce7af954e777053.html',''); initResizable(); });
66+
/* @license-end */
67+
</script>
68+
<div id="doc-content">
69+
<!-- window showing the filter options -->
70+
<div id="MSearchSelectWindow"
71+
onmouseover="return searchBox.OnSearchSelectShow()"
72+
onmouseout="return searchBox.OnSearchSelectHide()"
73+
onkeydown="return searchBox.OnSearchSelectKey(event)">
74+
</div>
75+
76+
<!-- iframe showing the search results (closed by default) -->
77+
<div id="MSearchResultsWindow">
78+
<iframe src="javascript:void(0)" frameborder="0"
79+
name="MSearchResults" id="MSearchResults">
80+
</iframe>
81+
</div>
82+
83+
<div class="header">
84+
<div class="headertitle">
85+
<div class="title">cli_lib Directory Reference</div> </div>
86+
</div><!--header-->
87+
<div class="contents">
88+
<table class="memberdecls">
89+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
90+
Files</h2></td></tr>
91+
<tr class="memitem:pa__cli__datetime_8py"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pa__cli__datetime_8py.html">pa_cli_datetime.py</a></td></tr>
92+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
93+
</table>
94+
</div><!-- contents -->
95+
</div><!-- doc-content -->
96+
<!-- start footer part -->
97+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
98+
<ul>
99+
<li class="navelem"><a class="el" href="dir_3e90ebb34b98c37ddce7af954e777053.html">cli_lib</a></li>
100+
<li class="footer">Generated by
101+
<a href="http://www.doxygen.org/index.html">
102+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
103+
</ul>
104+
</div>
105+
</body>
106+
</html>
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
var dir_3e90ebb34b98c37ddce7af954e777053 =
2+
[
3+
[ "pa_cli_datetime.py", "pa__cli__datetime_8py.html", "pa__cli__datetime_8py" ]
4+
];

docs/python/files.html

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,21 +87,23 @@
8787
<div class="contents">
8888
<div class="textblock">Here is a list of all files with brief descriptions:</div><div class="directory">
8989
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
90-
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html" target="_self">lib</a></td><td class="desc"></td></tr>
91-
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__binary_8py.html" target="_self">pa_binary.py</a></td><td class="desc"></td></tr>
92-
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__binary__data_8py.html" target="_self">pa_binary_data.py</a></td><td class="desc"></td></tr>
93-
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__comet_8py.html" target="_self">pa_comet.py</a></td><td class="desc"></td></tr>
94-
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__comet__data_8py.html" target="_self">pa_comet_data.py</a></td><td class="desc"></td></tr>
95-
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__coordinate_8py.html" target="_self">pa_coordinate.py</a></td><td class="desc"></td></tr>
96-
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__datetime_8py.html" target="_self">pa_datetime.py</a></td><td class="desc"></td></tr>
97-
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__eclipses_8py.html" target="_self">pa_eclipses.py</a></td><td class="desc"></td></tr>
98-
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__macro_8py.html" target="_self">pa_macro.py</a></td><td class="desc"></td></tr>
99-
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__moon_8py.html" target="_self">pa_moon.py</a></td><td class="desc"></td></tr>
100-
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__planet_8py.html" target="_self">pa_planet.py</a></td><td class="desc"></td></tr>
101-
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__planet__data_8py.html" target="_self">pa_planet_data.py</a></td><td class="desc"></td></tr>
102-
<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__sun_8py.html" target="_self">pa_sun.py</a></td><td class="desc"></td></tr>
103-
<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__util_8py.html" target="_self">pa_util.py</a></td><td class="desc"></td></tr>
104-
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="dir_8ebb4883bd5210c1437544ca4cb0df32.html" target="_self">src</a></td><td class="desc"></td></tr>
90+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_3e90ebb34b98c37ddce7af954e777053.html" target="_self">cli_lib</a></td><td class="desc"></td></tr>
91+
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__cli__datetime_8py.html" target="_self">pa_cli_datetime.py</a></td><td class="desc"></td></tr>
92+
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span id="img_1_" class="iconfopen" onclick="toggleFolder('1_')">&#160;</span><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html" target="_self">lib</a></td><td class="desc"></td></tr>
93+
<tr id="row_1_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__binary_8py.html" target="_self">pa_binary.py</a></td><td class="desc"></td></tr>
94+
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__binary__data_8py.html" target="_self">pa_binary_data.py</a></td><td class="desc"></td></tr>
95+
<tr id="row_1_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__comet_8py.html" target="_self">pa_comet.py</a></td><td class="desc"></td></tr>
96+
<tr id="row_1_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__comet__data_8py.html" target="_self">pa_comet_data.py</a></td><td class="desc"></td></tr>
97+
<tr id="row_1_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__coordinate_8py.html" target="_self">pa_coordinate.py</a></td><td class="desc"></td></tr>
98+
<tr id="row_1_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__datetime_8py.html" target="_self">pa_datetime.py</a></td><td class="desc"></td></tr>
99+
<tr id="row_1_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__eclipses_8py.html" target="_self">pa_eclipses.py</a></td><td class="desc"></td></tr>
100+
<tr id="row_1_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__macro_8py.html" target="_self">pa_macro.py</a></td><td class="desc"></td></tr>
101+
<tr id="row_1_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__moon_8py.html" target="_self">pa_moon.py</a></td><td class="desc"></td></tr>
102+
<tr id="row_1_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__planet_8py.html" target="_self">pa_planet.py</a></td><td class="desc"></td></tr>
103+
<tr id="row_1_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__planet__data_8py.html" target="_self">pa_planet_data.py</a></td><td class="desc"></td></tr>
104+
<tr id="row_1_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__sun_8py.html" target="_self">pa_sun.py</a></td><td class="desc"></td></tr>
105+
<tr id="row_1_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="pa__util_8py.html" target="_self">pa_util.py</a></td><td class="desc"></td></tr>
106+
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="dir_8ebb4883bd5210c1437544ca4cb0df32.html" target="_self">src</a></td><td class="desc"></td></tr>
105107
</table>
106108
</div><!-- directory -->
107109
</div><!-- contents -->

docs/python/files_dup.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
var files_dup =
22
[
3+
[ "cli_lib", "dir_3e90ebb34b98c37ddce7af954e777053.html", "dir_3e90ebb34b98c37ddce7af954e777053" ],
34
[ "lib", "dir_97aefd0d527b934f1d99a682da8fe6a9.html", "dir_97aefd0d527b934f1d99a682da8fe6a9" ],
45
[ "src", "dir_8ebb4883bd5210c1437544ca4cb0df32.html", null ]
56
];

docs/python/namespacemembers_c.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
9090
<li>cd_jd()
9191
: <a class="el" href="namespacepa__macro.html#a6017ad11aa20780e09d078eda04782c8">pa_macro</a>
9292
</li>
93+
<li>cd_to_dn()
94+
: <a class="el" href="namespacepa__cli__datetime.html#af3b7d2ac5f3957d81dd78f33ecc5ed64">pa_cli_datetime</a>
95+
</li>
9396
<li>civil_date_to_day_number()
9497
: <a class="el" href="namespacepa__datetime.html#ac6ab82ce401b647455c0d6a2c3034082">pa_datetime</a>
9598
</li>
@@ -111,6 +114,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
111114
<li>corrections_for_geocentric_parallax()
112115
: <a class="el" href="namespacepa__coordinate.html#a71aeafca0e8e028b70a5a5d9b636e934">pa_coordinate</a>
113116
</li>
117+
<li>ct_to_dh()
118+
: <a class="el" href="namespacepa__cli__datetime.html#ac87d57656e098fabc4f3f6c52930e55e">pa_cli_datetime</a>
119+
</li>
114120
</ul>
115121
</div><!-- contents -->
116122
</div><!-- doc-content -->

docs/python/namespacemembers_d.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,15 @@ <h3><a id="index_d"></a>- d -</h3><ul>
126126
<li>dh_sec()
127127
: <a class="el" href="namespacepa__macro.html#ab6b77a4307ef5fdfb7a6816f093eae0b">pa_macro</a>
128128
</li>
129+
<li>dh_to_ct()
130+
: <a class="el" href="namespacepa__cli__datetime.html#a3f151279132e41392cf1e370b3f5f032">pa_cli_datetime</a>
131+
</li>
129132
<li>dms_dd()
130133
: <a class="el" href="namespacepa__macro.html#af8e177250b71eef6e8854f4d57e97d3d">pa_macro</a>
131134
</li>
135+
<li>doe_year()
136+
: <a class="el" href="namespacepa__cli__datetime.html#a26999747714bbc803466e05eef1062a1">pa_cli_datetime</a>
137+
</li>
132138
</ul>
133139
</div><!-- contents -->
134140
</div><!-- doc-content -->

docs/python/namespacemembers_func_c.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
9090
<li>cd_jd()
9191
: <a class="el" href="namespacepa__macro.html#a6017ad11aa20780e09d078eda04782c8">pa_macro</a>
9292
</li>
93+
<li>cd_to_dn()
94+
: <a class="el" href="namespacepa__cli__datetime.html#af3b7d2ac5f3957d81dd78f33ecc5ed64">pa_cli_datetime</a>
95+
</li>
9396
<li>civil_date_to_day_number()
9497
: <a class="el" href="namespacepa__datetime.html#ac6ab82ce401b647455c0d6a2c3034082">pa_datetime</a>
9598
</li>
@@ -105,6 +108,9 @@ <h3><a id="index_c"></a>- c -</h3><ul>
105108
<li>corrections_for_geocentric_parallax()
106109
: <a class="el" href="namespacepa__coordinate.html#a71aeafca0e8e028b70a5a5d9b636e934">pa_coordinate</a>
107110
</li>
111+
<li>ct_to_dh()
112+
: <a class="el" href="namespacepa__cli__datetime.html#ac87d57656e098fabc4f3f6c52930e55e">pa_cli_datetime</a>
113+
</li>
108114
</ul>
109115
</div><!-- contents -->
110116
</div><!-- doc-content -->

docs/python/namespacemembers_func_d.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,15 @@ <h3><a id="index_d"></a>- d -</h3><ul>
126126
<li>dh_sec()
127127
: <a class="el" href="namespacepa__macro.html#ab6b77a4307ef5fdfb7a6816f093eae0b">pa_macro</a>
128128
</li>
129+
<li>dh_to_ct()
130+
: <a class="el" href="namespacepa__cli__datetime.html#a3f151279132e41392cf1e370b3f5f032">pa_cli_datetime</a>
131+
</li>
129132
<li>dms_dd()
130133
: <a class="el" href="namespacepa__macro.html#af8e177250b71eef6e8854f4d57e97d3d">pa_macro</a>
131134
</li>
135+
<li>doe_year()
136+
: <a class="el" href="namespacepa__cli__datetime.html#a26999747714bbc803466e05eef1062a1">pa_cli_datetime</a>
137+
</li>
132138
</ul>
133139
</div><!-- contents -->
134140
</div><!-- doc-content -->

docs/python/namespacemembers_func_g.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
8787
<li>galactic_coordinate_to_equatorial_coordinate()
8888
: <a class="el" href="namespacepa__coordinate.html#a7201bdefdd8a6fe7b4ab894b5950eab0">pa_coordinate</a>
8989
</li>
90+
<li>gd_to_jd()
91+
: <a class="el" href="namespacepa__cli__datetime.html#a54d8a1d6ec8a5483500861f3708b79ef">pa_cli_datetime</a>
92+
</li>
9093
<li>get_binary_data()
9194
: <a class="el" href="namespacepa__binary__data.html#a270acd135ad9e69a0d0478b07d744e37">pa_binary_data</a>
9295
</li>
@@ -114,6 +117,12 @@ <h3><a id="index_g"></a>- g -</h3><ul>
114117
<li>gst_lst()
115118
: <a class="el" href="namespacepa__macro.html#a2e33fbccab51d9a365694f552fef1128">pa_macro</a>
116119
</li>
120+
<li>gst_to_lst()
121+
: <a class="el" href="namespacepa__cli__datetime.html#a29ba5bd1f640f7cad6101fa348dca2bd">pa_cli_datetime</a>
122+
</li>
123+
<li>gst_to_ut()
124+
: <a class="el" href="namespacepa__cli__datetime.html#a77701869efddb707e5d9b95df45371ec">pa_cli_datetime</a>
125+
</li>
117126
<li>gst_ut()
118127
: <a class="el" href="namespacepa__macro.html#af8b51703b469dd44b2a2377d62ee72f7">pa_macro</a>
119128
</li>

0 commit comments

Comments
 (0)