-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeveloper_notes.html
More file actions
156 lines (135 loc) · 8.67 KB
/
Copy pathdeveloper_notes.html
File metadata and controls
156 lines (135 loc) · 8.67 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
<!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>Developer notes — Nornir 1.7.6 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
<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=6cfcd222"></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" />
<link rel="next" title="Markdown in the monodoc" href="development/markdown_in_sphinx.html" />
<link rel="prev" title="Pyre development" href="development/pyre_development.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">
Nornir
</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">
<p class="caption" role="heading"><span class="caption-text">Start</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="start.html">Start here</a></li>
<li class="toctree-l1"><a class="reference internal" href="host_requirements.html">Host requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Concepts</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_alignment_theory.html">Overview of volume building</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="guides/index.html">Guides</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Agents and contributors</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="agents.html">Agents and contributors</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Performance</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="performance/index.html">Performance</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="packages/index.html">Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="pipelines.html">Pipeline catalogue</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker/index.html">Docker images</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="development/index.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="development/release.html">Release process</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/publishing_documentation.html">Publishing the documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/github_pages.html">GitHub Pages hosting</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/logging.html">Logging convention</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/pyre_development.html">Pyre development</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Developer notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/markdown_in_sphinx.html">Markdown in the monodoc</a></li>
<li class="toctree-l2"><a class="reference internal" href="refine-grid-cpp-parity-checklist.html">ir-refine-grid C++ → Python Parity Checklist</a></li>
<li class="toctree-l2"><a class="reference internal" href="refine-grid690-python-parity-changelog.html">Grid690 Python Refine-Grid Parity — Change Log</a></li>
<li class="toctree-l2"><a class="reference internal" href="ir-blob-cpp-parity-checklist.html">ir-blob C++ → Python parity checklist</a></li>
</ul>
</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">Nornir</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"><a href="development/index.html">Development</a></li>
<li class="breadcrumb-item active">Developer notes</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/developer_notes.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="developer-notes">
<h1>Developer notes<a class="headerlink" href="#developer-notes" title="Link to this heading"></a></h1>
<p>This repository is an <strong>umbrella</strong> checkout that contains multiple <code class="docutils literal notranslate"><span class="pre">nornir-*</span></code> packages side by side. Contributor setup, editable installs, and test conventions are in <a class="reference internal" href="agents.html"><span class="doc">Agents and contributors</span></a>.</p>
<ul class="simple">
<li><p><strong>Monodoc:</strong> <a class="reference external" href="https://nornir.github.io/">https://nornir.github.io/</a> — full documentation and API reference.</p></li>
<li><p><strong>Publishing:</strong> <a class="reference internal" href="development/publishing_documentation.html"><span class="doc">Publishing the documentation</span></a> describes how HTML is built and deployed to the <code class="docutils literal notranslate"><span class="pre">nornir.github.io</span></code> site.</p></li>
</ul>
<p>When adding features, prefer updating the <strong>monodoc</strong> (reStructuredText under <code class="docutils literal notranslate"><span class="pre">docs/</span></code>) and keep package <code class="docutils literal notranslate"><span class="pre">README.md</span></code> files short—overview plus links to this site.</p>
<p>Grid-refine and blob parity audits (C++ tools versus the Python ports) are listed under <a class="reference internal" href="development/index.html"><span class="doc">Development</span></a>.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="development/pyre_development.html" class="btn btn-neutral float-left" title="Pyre development" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="development/markdown_in_sphinx.html" class="btn btn-neutral float-right" title="Markdown in the monodoc" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Nornir contributors.</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>