generate_documentation.html
9.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Generate this documentation — Mount Control Software 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Classes for driving mounts" href="autodoc_mount.html" />
<link rel="prev" title="User guide to program with celme Python classes" href="using_celme_classes.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="autodoc_mount.html" title="Classes for driving mounts"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="using_celme_classes.html" title="User guide to program with celme Python classes"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Mount Control Software 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Generate this documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="generate-this-documentation">
<h1>Generate this documentation<a class="headerlink" href="#generate-this-documentation" title="Permalink to this headline">¶</a></h1>
<p>This documentation is generated by the use of Sphinx and Pyreverse.
Sphinx uses the <a class="reference external" href="https://en.wikipedia.org/wiki/ReStructuredText">Restructured Text format</a>.
The following links gives some informations about the syntax:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="https://deusyss.developpez.com/tutoriels/Python/SphinxDoc/">Tutorial Sphinx 1</a>.</p></li>
<li><p><a class="reference external" href="https://www.mankier.com/1/sphinx-all">Tutorial Sphinx 2</a>.</p></li>
<li><p><a class="reference external" href="https://www.codeflow.site/fr/article/documenting-python-code">Tutorial documentation</a>.</p></li>
<li><p><a class="reference external" href="https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html">Tutorial reST</a>.</p></li>
<li><p><a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#module-sphinx.ext.napoleon">Tutorial Napoleon extension</a>.</p></li>
</ul>
</div></blockquote>
<div class="section" id="installation-of-sphinx-and-pyreverse">
<h2>Installation of Sphinx and Pyreverse<a class="headerlink" href="#installation-of-sphinx-and-pyreverse" title="Permalink to this headline">¶</a></h2>
<p>Procedure for Linux (root privileges):</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo pip3 install sphinx
sudo pip3 install rst2pdf
sudo pip3 install pylint
sudo pip3 install sphinx_pyreverse
sudo pip3 install graphviz
sudo apt-get install graphviz graphviz-dev
sudo pip3 install pygraphviz
</pre></div>
</div>
<p>Procedure for Windows (user xxx). First you must download and install
<a class="reference external" href="https://graphviz.org/">Graphviz</a>. Then:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> c:<span class="se">\U</span>sers<span class="se">\x</span>xx<span class="se">\A</span>naconda3<span class="se">\S</span>cripts
.<span class="se">\p</span>ip install -U Sphinx
.<span class="se">\p</span>ip install rst2pdf
.<span class="se">\c</span>onda install pyreverse
.<span class="se">\c</span>onda install python-graphviz
</pre></div>
</div>
</div>
<div class="section" id="generate-the-documentation">
<h2>Generate the documentation<a class="headerlink" href="#generate-the-documentation" title="Permalink to this headline">¶</a></h2>
<p>To generate the documentation you must start to execute pyreverse
followed by sphinx.</p>
<p>Procedure pyreverse for Linux:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /home/pi/astromecca/doc_rst/doc_pyreverse
pyreverse3 -p mount -o png --ignore<span class="o">=</span>celme ../../mountastro
pyreverse3 -p celme -o png --ignore<span class="o">=</span>mountastro ../../celme
cp classes_*.png ../doc_images
</pre></div>
</div>
<p>Procedure sphinx for Linux:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /home/pi/astromecca/doc_rst
sphinx-build -b html . ./../doc_html
sphinx-build -b pdf . ./../doc_pdf
</pre></div>
</div>
<p>Procedure pyreverse for Windows (user xxx):</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> astromecca<span class="se">\d</span>oc_rst<span class="se">\d</span>oc_pyreverse
c:<span class="se">\U</span>sers<span class="se">\x</span>xx<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="se">\p</span>yreverse -p mount -o png --ignore<span class="o">=</span>celme ../../mountastro
c:<span class="se">\U</span>sers<span class="se">\x</span>xx<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="se">\p</span>yreverse -p celme -o png --ignore<span class="o">=</span>mountastro ../../celme
copy classes_*.png ..<span class="se">\d</span>oc_images
</pre></div>
</div>
<p>Procedure sphinx for Windows (user xxx):</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> astromecca<span class="se">\d</span>oc_rst
C:<span class="se">\U</span>sers<span class="se">\x</span>xx<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="se">\s</span>phinx-build -b html . .<span class="se">\.</span>.<span class="se">\d</span>oc_html
C:<span class="se">\U</span>sers<span class="se">\x</span>xx<span class="se">\A</span>naconda3<span class="se">\S</span>cripts<span class="se">\s</span>phinx-build -b pdf . .<span class="se">\.</span>.<span class="se">\d</span>oc_pdf
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Generate this documentation</a><ul>
<li><a class="reference internal" href="#installation-of-sphinx-and-pyreverse">Installation of Sphinx and Pyreverse</a></li>
<li><a class="reference internal" href="#generate-the-documentation">Generate the documentation</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="using_celme_classes.html"
title="previous chapter">User guide to program with celme Python classes</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="autodoc_mount.html"
title="next chapter">Classes for driving mounts</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/generate_documentation.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="autodoc_mount.html" title="Classes for driving mounts"
>next</a> |</li>
<li class="right" >
<a href="using_celme_classes.html" title="User guide to program with celme Python classes"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Mount Control Software 1.0.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Generate this documentation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2021, astromecca.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.0.
</div>
</body>
</html>