-
Notifications
You must be signed in to change notification settings - Fork 7
/
application_documentation.html
210 lines (197 loc) · 9.08 KB
/
application_documentation.html
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Application documentation — Clawpack 5.11.x documentation</title>
<link rel="stylesheet" href="_static/base.css" type="text/css" />
<link rel="stylesheet" href="_static/layout.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/flasky.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="shortcut icon" href="_static/clawicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Specifying classic run-time parameters in setrun.py" href="setrun.html" />
<link rel="prev" title="b4run function" href="b4run.html" />
</head><body>
<div id="main-wrapper" class="sphinx">
<div id="header-wrapper">
<section id="header">
<!-- <h1><a href="http://clawpack.org/">Clawpack</a></h1> -->
<h1><a href="http://clawpack.org/">Clawpack-5</a></h1>
<nav>
<ul>
<li>
<a href="contents.html">Docs</a>
</li>
<li>
<a href="installing.html">Install</a>
</li>
<li>
<a class="" href="http://clawpack.org/gallery/index.html">Gallery</a>
</li>
<li>
<a href="about.html">Citation</a>
</li>
<li>
<a class="active" href="http://github.com/clawpack">GitHub</a>
</li>
<li>
<a class="" href="community.html">Community</a>
</li>
<li>
<a class="" href="developers.html">Contribute</a>
</li>
</ul>
</nav>
</section>
<div class="decoration"></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"
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="setrun.html" title="Specifying classic run-time parameters in setrun.py"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="b4run.html" title="b4run function"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.11.x documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Application documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="application-documentation">
<span id="id1"></span><h1>Application documentation<a class="headerlink" href="#application-documentation" title="Permalink to this heading">¶</a></h1>
<section id="converting-readme-rst-to-readme-html">
<span id="convert-readme"></span><h2>Converting README.rst to README.html<a class="headerlink" href="#converting-readme-rst-to-readme-html" title="Permalink to this heading">¶</a></h2>
<p>In Fortran versions of Clawpack-5, the main documentation page
for an application is often found
in a file named <cite>README.rst</cite>, which can be written using the markup language
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructured Text</a>.
This is the markup language used by <a class="reference external" href="http://sphinx-doc.org/">Sphinx</a> for
all of the Clawpack documentation.</p>
<p>The <cite>README.rst</cite> file can be coverted into a <cite>README.html</cite> file by doing:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>python $CLAW/clawutil/src/python/clawutil/convert_readme.py
</pre></div>
</div>
<p>This is also automatically done by the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="o">.</span><span class="n">htmls</span>
</pre></div>
</div>
<p>which also converts code files into html files for easy browsing.
A list of code files in the directory is automatically generated by
<cite>convert_readme.py</cite> and links inserted in <cite>README.html</cite>.</p>
</section>
<section id="converting-code-to-html-with-clawcode2html">
<span id="clawcode2html"></span><h2>Converting code to html with clawcode2html<a class="headerlink" href="#converting-code-to-html-with-clawcode2html" title="Permalink to this heading">¶</a></h2>
<p>The Python script <cite>$CLAW/clawutil/src/python/clawutil/clawcode2html.py</cite> is
invoked by “make .htmls” (in applications directories having Makefiles).</p>
<p>This script does minor syntax highlighting by attempting to put comments in
blue and adds a header at the top.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.11.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Application documentation</a><ul>
<li><a class="reference internal" href="#converting-readme-rst-to-readme-html">Converting README.rst to README.html</a></li>
<li><a class="reference internal" href="#converting-code-to-html-with-clawcode2html">Converting code to html with clawcode2html</a></li>
</ul>
</li>
</ul>
</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li>Previous: <a href="b4run.html" title="previous chapter">b4run function</a></li>
<li>Next: <a href="setrun.html" title="next chapter">Specifying classic run-time parameters in <cite>setrun.py</cite></a></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/application_documentation.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/application_documentation.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/application_documentation.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/application_documentation.rst"
rel="nofollow"
target="_blank">Suggest Edits</a></li>
<li><a href="https://github.com/clawpack/doc/issues/new/choose"
rel="nofollow"
target="_blank">Raise an Issue</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/application_documentation.html">dev</a></li>
<li><a href="application_documentation.html">v5.11.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.10.x/application_documentation.html">v5.10.x</a></li>
<li><a href="./v5.7.x/application_documentation.html">v5.7.x</a></li>
<li><a href="./v5.8.x/application_documentation.html">v5.8.x</a></li>
<li><a href="./v5.9.x/application_documentation.html">v5.9.x</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44811544-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>