code_style.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. <!DOCTYPE HTML>
  2. <html lang="en" class="sidebar-visible no-js light">
  3. <head>
  4. <!-- Book generated using mdBook -->
  5. <meta charset="UTF-8">
  6. <title>Code Style - Synapse</title>
  7. <!-- Custom HTML head -->
  8. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  9. <meta name="description" content="">
  10. <meta name="viewport" content="width=device-width, initial-scale=1">
  11. <meta name="theme-color" content="#ffffff" />
  12. <link rel="icon" href="favicon.svg">
  13. <link rel="shortcut icon" href="favicon.png">
  14. <link rel="stylesheet" href="css/variables.css">
  15. <link rel="stylesheet" href="css/general.css">
  16. <link rel="stylesheet" href="css/chrome.css">
  17. <link rel="stylesheet" href="css/print.css" media="print">
  18. <!-- Fonts -->
  19. <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
  20. <link rel="stylesheet" href="fonts/fonts.css">
  21. <!-- Highlight.js Stylesheets -->
  22. <link rel="stylesheet" href="highlight.css">
  23. <link rel="stylesheet" href="tomorrow-night.css">
  24. <link rel="stylesheet" href="ayu-highlight.css">
  25. <!-- Custom theme stylesheets -->
  26. <link rel="stylesheet" href="docs/website_files/table-of-contents.css">
  27. <link rel="stylesheet" href="docs/website_files/remove-nav-buttons.css">
  28. <link rel="stylesheet" href="docs/website_files/indent-section-headers.css">
  29. <link rel="stylesheet" href="docs/website_files/version-picker.css">
  30. </head>
  31. <body>
  32. <!-- Provide site root to javascript -->
  33. <script type="text/javascript">
  34. var path_to_root = "";
  35. var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
  36. </script>
  37. <!-- Work around some values being stored in localStorage wrapped in quotes -->
  38. <script type="text/javascript">
  39. try {
  40. var theme = localStorage.getItem('mdbook-theme');
  41. var sidebar = localStorage.getItem('mdbook-sidebar');
  42. if (theme.startsWith('"') && theme.endsWith('"')) {
  43. localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
  44. }
  45. if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
  46. localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
  47. }
  48. } catch (e) { }
  49. </script>
  50. <!-- Set the theme before any content is loaded, prevents flash -->
  51. <script type="text/javascript">
  52. var theme;
  53. try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
  54. if (theme === null || theme === undefined) { theme = default_theme; }
  55. var html = document.querySelector('html');
  56. html.classList.remove('no-js')
  57. html.classList.remove('light')
  58. html.classList.add(theme);
  59. html.classList.add('js');
  60. </script>
  61. <!-- Hide / unhide sidebar before it is displayed -->
  62. <script type="text/javascript">
  63. var html = document.querySelector('html');
  64. var sidebar = 'hidden';
  65. if (document.body.clientWidth >= 1080) {
  66. try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
  67. sidebar = sidebar || 'visible';
  68. }
  69. html.classList.remove('sidebar-visible');
  70. html.classList.add("sidebar-" + sidebar);
  71. </script>
  72. <nav id="sidebar" class="sidebar" aria-label="Table of contents">
  73. <div class="sidebar-scrollbox">
  74. <ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="turn-howto.html">Configuring a Turn Server</a></li><li class="chapter-item expanded "><a href="delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded "><a href="MSC1711_certificates_FAQ.html">Upgrading from pre-Synapse 1.0</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="federate.html">Federation</a></li><li class="chapter-item expanded "><a href="usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="templates.html">Templates</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single-Sign On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><div>SAML</div></li><li class="chapter-item expanded "><div>CAS</div></li><li class="chapter-item expanded "><a href="sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="jwt.html">JSON Web Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="development/url_previews.html">URL Previews</a></li><li class="chapter-item expanded "><a href="user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class="chapter-item expanded "><a href="modules/third_party_rules_callbacks.html">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="modules/password_auth_provider_callbacks.html">Password auth provider callbacks</a></li><li class="chapter-item expanded "><a href="modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/background_updates.html">Background Updates</a></li><li class="chapter-item expanded "><a href="admin_api/delete_group.html">Delete Group</a></li><li class="chapter-item expanded "><a href="admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="admin_api/version_api.html">Server Version</a></li></ol></li><li class="chapter-item expanded "><a href="manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="metrics-howto.html">Monitoring</a></li><li class="chapter-item expanded "><a href="usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="code_style.html" class="active">Code Style</a></li><li class="chapter-item expanded "><a href="development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li class="chapter-item expanded "><a href="opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="replication.html">Replication</a></li><li class="chapter-item expanded "><a href="tcp_replication.html">TCP Replication</a></li></ol></li><li class="chapter-item expanded "><a href="development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="deprecation_policy.html">Dependency Deprecation Policy</a></li></ol>
  75. </div>
  76. <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
  77. </nav>
  78. <div id="page-wrapper" class="page-wrapper">
  79. <div class="page">
  80. <div id="menu-bar-hover-placeholder"></div>
  81. <div id="menu-bar" class="menu-bar sticky bordered">
  82. <div class="left-buttons">
  83. <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
  84. <i class="fa fa-bars"></i>
  85. </button>
  86. <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
  87. <i class="fa fa-paint-brush"></i>
  88. </button>
  89. <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
  90. <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
  91. <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
  92. <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
  93. <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
  94. <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
  95. </ul>
  96. <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
  97. <i class="fa fa-search"></i>
  98. </button>
  99. <div class="version-picker">
  100. <div class="dropdown">
  101. <div class="select">
  102. <span></span>
  103. <i class="fa fa-chevron-down"></i>
  104. </div>
  105. <input type="hidden" name="version">
  106. <ul class="dropdown-menu">
  107. <!-- Versions will be added dynamically in version-picker.js -->
  108. </ul>
  109. </div>
  110. </div>
  111. </div>
  112. <h1 class="menu-title">Synapse</h1>
  113. <div class="right-buttons">
  114. <a href="print.html" title="Print this book" aria-label="Print this book">
  115. <i id="print-button" class="fa fa-print"></i>
  116. </a>
  117. <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository">
  118. <i id="git-repository-button" class="fa fa-github"></i>
  119. </a>
  120. <a href="https://github.com/matrix-org/synapse/edit/develop/docs/code_style.md" title="Suggest an edit" aria-label="Suggest an edit">
  121. <i id="git-edit-button" class="fa fa-edit"></i>
  122. </a>
  123. </div>
  124. </div>
  125. <div id="search-wrapper" class="hidden">
  126. <form id="searchbar-outer" class="searchbar-outer">
  127. <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
  128. </form>
  129. <div id="searchresults-outer" class="searchresults-outer hidden">
  130. <div id="searchresults-header" class="searchresults-header"></div>
  131. <ul id="searchresults">
  132. </ul>
  133. </div>
  134. </div>
  135. <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
  136. <script type="text/javascript">
  137. document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
  138. document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
  139. Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
  140. link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
  141. });
  142. </script>
  143. <div id="content" class="content">
  144. <main>
  145. <!-- Page table of contents -->
  146. <div class="sidetoc">
  147. <nav class="pagetoc"></nav>
  148. </div>
  149. <h1 id="code-style"><a class="header" href="#code-style">Code Style</a></h1>
  150. <h2 id="formatting-tools"><a class="header" href="#formatting-tools">Formatting tools</a></h2>
  151. <p>The Synapse codebase uses a number of code formatting tools in order to
  152. quickly and automatically check for formatting (and sometimes logical)
  153. errors in code.</p>
  154. <p>The necessary tools are detailed below.</p>
  155. <p>First install them with:</p>
  156. <pre><code class="language-sh">pip install -e &quot;.[lint,mypy]&quot;
  157. </code></pre>
  158. <ul>
  159. <li>
  160. <p><strong>black</strong></p>
  161. <p>The Synapse codebase uses <a href="https://pypi.org/project/black/">black</a>
  162. as an opinionated code formatter, ensuring all comitted code is
  163. properly formatted.</p>
  164. <p>Have <code>black</code> auto-format your code (it shouldn't change any
  165. functionality) with:</p>
  166. <pre><code class="language-sh">black . --exclude=&quot;\.tox|build|env&quot;
  167. </code></pre>
  168. </li>
  169. <li>
  170. <p><strong>flake8</strong></p>
  171. <p><code>flake8</code> is a code checking tool. We require code to pass <code>flake8</code>
  172. before being merged into the codebase.</p>
  173. <p>Check all application and test code with:</p>
  174. <pre><code class="language-sh">flake8 synapse tests
  175. </code></pre>
  176. </li>
  177. <li>
  178. <p><strong>isort</strong></p>
  179. <p><code>isort</code> ensures imports are nicely formatted, and can suggest and
  180. auto-fix issues such as double-importing.</p>
  181. <p>Auto-fix imports with:</p>
  182. <pre><code class="language-sh">isort -rc synapse tests
  183. </code></pre>
  184. <p><code>-rc</code> means to recursively search the given directories.</p>
  185. </li>
  186. </ul>
  187. <p>It's worth noting that modern IDEs and text editors can run these tools
  188. automatically on save. It may be worth looking into whether this
  189. functionality is supported in your editor for a more convenient
  190. development workflow. It is not, however, recommended to run <code>flake8</code> on
  191. save as it takes a while and is very resource intensive.</p>
  192. <h2 id="general-rules"><a class="header" href="#general-rules">General rules</a></h2>
  193. <ul>
  194. <li><strong>Naming</strong>:
  195. <ul>
  196. <li>Use camel case for class and type names</li>
  197. <li>Use underscores for functions and variables.</li>
  198. </ul>
  199. </li>
  200. <li><strong>Docstrings</strong>: should follow the <a href="https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings">google code
  201. style</a>.
  202. See the
  203. <a href="http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html">examples</a>
  204. in the sphinx documentation.</li>
  205. <li><strong>Imports</strong>:
  206. <ul>
  207. <li>
  208. <p>Imports should be sorted by <code>isort</code> as described above.</p>
  209. </li>
  210. <li>
  211. <p>Prefer to import classes and functions rather than packages or
  212. modules.</p>
  213. <p>Example:</p>
  214. <pre><code class="language-python">from synapse.types import UserID
  215. ...
  216. user_id = UserID(local, server)
  217. </code></pre>
  218. <p>is preferred over:</p>
  219. <pre><code class="language-python">from synapse import types
  220. ...
  221. user_id = types.UserID(local, server)
  222. </code></pre>
  223. <p>(or any other variant).</p>
  224. <p>This goes against the advice in the Google style guide, but it
  225. means that errors in the name are caught early (at import time).</p>
  226. </li>
  227. <li>
  228. <p>Avoid wildcard imports (<code>from synapse.types import *</code>) and
  229. relative imports (<code>from .types import UserID</code>).</p>
  230. </li>
  231. </ul>
  232. </li>
  233. </ul>
  234. <h2 id="configuration-file-format"><a class="header" href="#configuration-file-format">Configuration file format</a></h2>
  235. <p>The <a href="./sample_config.yaml">sample configuration file</a> acts as a
  236. reference to Synapse's configuration options for server administrators.
  237. Remember that many readers will be unfamiliar with YAML and server
  238. administration in general, so that it is important that the file be as
  239. easy to understand as possible, which includes following a consistent
  240. format.</p>
  241. <p>Some guidelines follow:</p>
  242. <ul>
  243. <li>
  244. <p>Sections should be separated with a heading consisting of a single
  245. line prefixed and suffixed with <code>##</code>. There should be <strong>two</strong> blank
  246. lines before the section header, and <strong>one</strong> after.</p>
  247. </li>
  248. <li>
  249. <p>Each option should be listed in the file with the following format:</p>
  250. <ul>
  251. <li>
  252. <p>A comment describing the setting. Each line of this comment
  253. should be prefixed with a hash (<code>#</code>) and a space.</p>
  254. <p>The comment should describe the default behaviour (ie, what
  255. happens if the setting is omitted), as well as what the effect
  256. will be if the setting is changed.</p>
  257. <p>Often, the comment end with something like &quot;uncomment the
  258. following to <do action>&quot;.</p>
  259. </li>
  260. <li>
  261. <p>A line consisting of only <code>#</code>.</p>
  262. </li>
  263. <li>
  264. <p>A commented-out example setting, prefixed with only <code>#</code>.</p>
  265. <p>For boolean (on/off) options, convention is that this example
  266. should be the <em>opposite</em> to the default (so the comment will end
  267. with &quot;Uncomment the following to enable [or disable]
  268. <feature>.&quot; For other options, the example should give some
  269. non-default value which is likely to be useful to the reader.</p>
  270. </li>
  271. </ul>
  272. </li>
  273. <li>
  274. <p>There should be a blank line between each option.</p>
  275. </li>
  276. <li>
  277. <p>Where several settings are grouped into a single dict, <em>avoid</em> the
  278. convention where the whole block is commented out, resulting in
  279. comment lines starting <code># #</code>, as this is hard to read and confusing
  280. to edit. Instead, leave the top-level config option uncommented, and
  281. follow the conventions above for sub-options. Ensure that your code
  282. correctly handles the top-level option being set to <code>None</code> (as it
  283. will be if no sub-options are enabled).</p>
  284. </li>
  285. <li>
  286. <p>Lines should be wrapped at 80 characters.</p>
  287. </li>
  288. <li>
  289. <p>Use two-space indents.</p>
  290. </li>
  291. <li>
  292. <p><code>true</code> and <code>false</code> are spelt thus (as opposed to <code>True</code>, etc.)</p>
  293. </li>
  294. <li>
  295. <p>Use single quotes (<code>'</code>) rather than double-quotes (<code>&quot;</code>) or backticks
  296. (<code>`</code>) to refer to configuration options.</p>
  297. </li>
  298. </ul>
  299. <p>Example:</p>
  300. <pre><code class="language-yaml">## Frobnication ##
  301. # The frobnicator will ensure that all requests are fully frobnicated.
  302. # To enable it, uncomment the following.
  303. #
  304. #frobnicator_enabled: true
  305. # By default, the frobnicator will frobnicate with the default frobber.
  306. # The following will make it use an alternative frobber.
  307. #
  308. #frobincator_frobber: special_frobber
  309. # Settings for the frobber
  310. #
  311. frobber:
  312. # frobbing speed. Defaults to 1.
  313. #
  314. #speed: 10
  315. # frobbing distance. Defaults to 1000.
  316. #
  317. #distance: 100
  318. </code></pre>
  319. <p>Note that the sample configuration is generated from the synapse code
  320. and is maintained by a script, <code>scripts-dev/generate_sample_config</code>.
  321. Making sure that the output from this script matches the desired format
  322. is left as an exercise for the reader!</p>
  323. </main>
  324. <nav class="nav-wrapper" aria-label="Page navigation">
  325. <!-- Mobile navigation buttons -->
  326. <a rel="prev" href="development/contributing_guide.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  327. <i class="fa fa-angle-left"></i>
  328. </a>
  329. <a rel="next" href="development/git.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  330. <i class="fa fa-angle-right"></i>
  331. </a>
  332. <div style="clear: both"></div>
  333. </nav>
  334. </div>
  335. </div>
  336. <nav class="nav-wide-wrapper" aria-label="Page navigation">
  337. <a rel="prev" href="development/contributing_guide.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  338. <i class="fa fa-angle-left"></i>
  339. </a>
  340. <a rel="next" href="development/git.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  341. <i class="fa fa-angle-right"></i>
  342. </a>
  343. </nav>
  344. </div>
  345. <script type="text/javascript">
  346. window.playground_copyable = true;
  347. </script>
  348. <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
  349. <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
  350. <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
  351. <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
  352. <script src="highlight.js" type="text/javascript" charset="utf-8"></script>
  353. <script src="book.js" type="text/javascript" charset="utf-8"></script>
  354. <!-- Custom JS scripts -->
  355. <script type="text/javascript" src="docs/website_files/table-of-contents.js"></script>
  356. <script type="text/javascript" src="docs/website_files/version-picker.js"></script>
  357. <script type="text/javascript" src="docs/website_files/version.js"></script>
  358. </body>
  359. </html>