Skip to content

Commit f62faaa

Browse files
committed
Add build notes
1 parent ae3fcac commit f62faaa

10 files changed

Lines changed: 70 additions & 27 deletions

File tree

13.2 KB
Binary file not shown.

docs/_site/.doctrees/index.doctree

-340 Bytes
Binary file not shown.

docs/_site/_sources/index.rst.txt

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,20 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
hispec documentation
6+
HISPEC Documentation
77
====================
88

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
9+
WIP! We'll be adding to this documentation during the project's lifecycle.
1310

1411
.. toctree::
1512
:maxdepth: 2
1613
:caption: Contents:
1714

15+
Build Notes
16+
===========
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
:glob:
21+
22+
build/*

docs/_site/genindex.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,15 @@
3939
</form>
4040
</div>
4141
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
42-
<!-- Local TOC -->
43-
<div class="local-toc"></div>
42+
<ul>
43+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html">Build Setup for hsdev FEI</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#user-and-hostname-setup">User and Hostname Setup</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#group-and-account-setup">Group and Account Setup</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#final-step">Final Step</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#done">Done!</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="build/host_machine_build_notes.html">Build Setup for hsdev User</a></li>
49+
</ul>
50+
4451
</div>
4552
</div>
4653
</nav>

docs/_site/index.html

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>hispec documentation &mdash; hispec documentation</title>
9+
<title>HISPEC Documentation &mdash; hispec documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

@@ -18,7 +18,8 @@
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>
2020
<link rel="index" title="Index" href="genindex.html" />
21-
<link rel="search" title="Search" href="search.html" />
21+
<link rel="search" title="Search" href="search.html" />
22+
<link rel="next" title="Build Setup for hsdev FEI" href="build/fei_server_build_notes.html" />
2223
</head>
2324

2425
<body class="wy-body-for-nav">
@@ -40,11 +41,15 @@
4041
</form>
4142
</div>
4243
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
43-
<!-- Local TOC -->
44-
<div class="local-toc"><ul>
45-
<li><a class="reference internal" href="#">hispec documentation</a></li>
44+
<ul>
45+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html">Build Setup for hsdev FEI</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#user-and-hostname-setup">User and Hostname Setup</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#group-and-account-setup">Group and Account Setup</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#final-step">Final Step</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#done">Done!</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="build/host_machine_build_notes.html">Build Setup for hsdev User</a></li>
4651
</ul>
47-
</div>
52+
4853
</div>
4954
</div>
5055
</nav>
@@ -59,7 +64,7 @@
5964
<div role="navigation" aria-label="Page navigation">
6065
<ul class="wy-breadcrumbs">
6166
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
62-
<li class="breadcrumb-item active">hispec documentation</li>
67+
<li class="breadcrumb-item active">HISPEC Documentation</li>
6368
<li class="wy-breadcrumbs-aside">
6469
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
6570
</li>
@@ -70,18 +75,31 @@
7075
<div itemprop="articleBody">
7176

7277
<section id="hispec-documentation">
73-
<h1>hispec documentation<a class="headerlink" href="#hispec-documentation" title="Link to this heading"></a></h1>
74-
<p>Add your content using <code class="docutils literal notranslate"><span class="pre">reStructuredText</span></code> syntax. See the
75-
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">reStructuredText</a>
76-
documentation for details.</p>
78+
<h1>HISPEC Documentation<a class="headerlink" href="#hispec-documentation" title="Link to this heading"></a></h1>
79+
<p>WIP! We’ll be adding to this documentation during the project’s lifecycle.</p>
80+
<div class="toctree-wrapper compound">
81+
</div>
82+
</section>
83+
<section id="build-notes">
84+
<h1>Build Notes<a class="headerlink" href="#build-notes" title="Link to this heading"></a></h1>
7785
<div class="toctree-wrapper compound">
86+
<ul>
87+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html">Build Setup for hsdev FEI</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#user-and-hostname-setup">User and Hostname Setup</a></li>
89+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#group-and-account-setup">Group and Account Setup</a></li>
90+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#final-step">Final Step</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#done">Done!</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="build/host_machine_build_notes.html">Build Setup for hsdev User</a></li>
93+
</ul>
7894
</div>
7995
</section>
8096

8197

8298
</div>
8399
</div>
84-
<footer>
100+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
101+
<a href="build/fei_server_build_notes.html" class="btn btn-neutral float-right" title="Build Setup for hsdev FEI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
102+
</div>
85103

86104
<hr/>
87105

docs/_site/objects.inv

67 Bytes
Binary file not shown.

docs/_site/search.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,15 @@
4242
</form>
4343
</div>
4444
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
45-
<!-- Local TOC -->
46-
<div class="local-toc"></div>
45+
<ul>
46+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html">Build Setup for hsdev FEI</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#user-and-hostname-setup">User and Hostname Setup</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#group-and-account-setup">Group and Account Setup</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#final-step">Final Step</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="build/fei_server_build_notes.html#done">Done!</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="build/host_machine_build_notes.html">Build Setup for hsdev User</a></li>
52+
</ul>
53+
4754
</div>
4855
</div>
4956
</nav>

docs/_site/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/source/build

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../build

docs/source/index.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,20 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
hispec documentation
6+
HISPEC Documentation
77
====================
88

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
9+
WIP! We'll be adding to this documentation during the project's lifecycle.
1310

1411
.. toctree::
1512
:maxdepth: 2
1613
:caption: Contents:
1714

15+
Build Notes
16+
===========
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
:glob:
21+
22+
build/*

0 commit comments

Comments
 (0)