ebm-docs/sphinx_guide.html at main · NVE/ebm-docs · GitHub

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


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Sphinx guide - INTERN &mdash; EBM - Energibruksmodell  documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=9ed7352e" />


      <script src="_static/jquery.js?v=5d32c60e"></script>
      <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="_static/documentation_options.js?v=5929fcd5"></script>
      <script src="_static/doctools.js?v=9bcbadda"></script>
      <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
</head>

<body class="wy-body-for-nav">
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >


          <a href="index.html" class="icon icon-home">
            EBM - Energibruksmodell
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul>
<li class="toctree-l1"><a class="reference internal" href="about_the_model.html">About EBM</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="results.html">Result files</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/user_case.html">User case</a></li>
<li class="toctree-l1"><a class="reference internal" href="input_description.html">Input files</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/geographical_distribution.html">Geographical distribution</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/configuration.html">Model configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Model Functionality</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="model_description/index.html">Model Description</a></li>
<li class="toctree-l1"><a class="reference internal" href="limitations.html">Limitations</a></li>
<li class="toctree-l1"><a class="reference internal" href="building_parameters/index.html">Building categories and building codes</a></li>
<li class="toctree-l1"><a class="reference internal" href="area/index.html">Area</a></li>
<li class="toctree-l1"><a class="reference internal" href="energy_need/index.html">Energy need</a></li>
<li class="toctree-l1"><a class="reference internal" href="heating_systems/index.html">Heating systems</a></li>
<li class="toctree-l1"><a class="reference internal" href="energy_use/index.html">Energy use</a></li>
<li class="toctree-l1"><a class="reference internal" href="geographical_distribution/index.html">Geographical distribution</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/calibrating_the_model.html">Calibrating the model</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">EBM - Energibruksmodell</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Sphinx guide - INTERN</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/sphinx_guide.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">

  <section id="sphinx-guide-intern">
<h1>Sphinx guide - INTERN<a class="headerlink" href="#sphinx-guide-intern" title="Link to this heading"></a></h1>
<section id="architecture-overview">
<h2>Architecture Overview<a class="headerlink" href="#architecture-overview" title="Link to this heading"></a></h2>
<p>The framework is built with the following architecture:</p>
<p>…</p>
</section>
<section id="extending-the-framework">
<h2>Extending the Framework<a class="headerlink" href="#extending-the-framework" title="Link to this heading"></a></h2>
<p>To add a new model, follow these steps:</p>
<p>…</p>
</section>
<section id="building-the-documentation">
<h2>Building the Documentation<a class="headerlink" href="#building-the-documentation" title="Link to this heading"></a></h2>
<p>The project documentation is built using Sphinx, a powerful tool that generates HTML documentation from reStructuredText files. Follow these steps to build the documentation:</p>
<ol class="arabic">
<li><p><strong>Navigate to the `docs` directory:</strong></p>
<p>From the project’s root directory, switch to the <cite>docs</cite> folder where the Sphinx configuration is located:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>docs
</pre></div>
</div>
</li>
<li><p><strong>Generate the API documentation:</strong></p>
<p>If you are on Windows, we have made a script to easily clear the HTML tree, generate the code documentation and then create the HTML pages including the manually written content and the generated content.</p>
<p>This is how to run the script on Windows:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>.<span class="se">\u</span>pdate_docs.bat
</pre></div>
</div>
<p>If you are on another operating system than Windows, you may adopt the script to your OS.</p>
</li>
<li><p><strong>How the script works:</strong></p>
<p>Before generating the documentation, it’s a good idea to clean any previous build artifacts to avoid conflicts:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>clean
</pre></div>
</div>
<p>The script uses the <cite>sphinx-apidoc</cite> command to automatically generate reStructuredText files for your Python modules.</p>
<p>To build the HTML documentation, run the following command to compile the documentation into HTML files:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html
</pre></div>
</div>
<p>The HTML files will be generated in the <cite>build/html</cite> directory.</p>
</li>
</ol>
</section>
<section id="hosting-the-documentation">
<h2>Hosting the Documentation<a class="headerlink" href="#hosting-the-documentation" title="Link to this heading"></a></h2>
<p>Once the HTML documentation is built, it needs to be hosted on a web server so that team members can access it through their browsers.</p>
<ol class="arabic">
<li><p><strong>Locate the built documentation:</strong></p>
<p>The HTML files are located in the <cite>build/html</cite> directory under the <cite>docs</cite> folder.</p>
</li>
<li><p><strong>Move the documentation to the web server:</strong></p>
<p>Copy the contents of the <cite>build/html</cite> directory to a web server directory. The method depends on your hosting setup. For example:
- If you use an FTP server, upload the files via an FTP client.
- If you use a cloud platform, sync the files using their command-line tools (e.g., <cite>aws s3 sync</cite>, <cite>gsutil cp</cite>, etc.).</p>
</li>
<li><p><strong>Access the documentation in your browser:</strong></p>
<p>Once hosted, the documentation will be accessible via a URL like <cite>http://yourserver.com/docs</cite>. Share this URL with your team so they can access the latest version of the documentation.</p>
</li>
</ol>
<p>By following these steps, you ensure that the project documentation is up-to-date and accessible to everyone involved.</p>
<p>Last Updated on 2026-04-10.</p>
<p>Version: 1.0.9.</p>
</section>
</section>


           </div>
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2025, The Norwegian Water Resources and Energy Directorate (NVE).</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

</body>
</html>