doc/html/Coding-guidelines/index.html

   1 <!DOCTYPE html>
   2 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   3 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   4 <head>
   5   <meta charset="utf-8">
   6   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   7   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   8
   9
  10   <link rel="shortcut icon" href="../img/favicon.ico">
  11   <title>Coding guidelines - Shaarli Documentation</title>
  12   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  13
  14   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  16   <link rel="stylesheet" href="../css/highlight.css">
  17   <link href="../github-markdown.css" rel="stylesheet">
  18
  19   <script>
  20     // Current page data
  21     var mkdocs_page_name = "Coding guidelines";
  22     var mkdocs_page_input_path = "Coding-guidelines.md";
  23     var mkdocs_page_url = "/Coding-guidelines/";
  24   </script>
  25
  26   <script src="../js/jquery-2.1.1.min.js"></script>
  27   <script src="../js/modernizr-2.8.3.min.js"></script>
  28   <script type="text/javascript" src="../js/highlight.pack.js"></script>
  29
  30 </head>
  31
  32 <body class="wy-body-for-nav" role="document">
  33
  34   <div class="wy-grid-for-nav">
  35
  36
  37     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  38       <div class="wy-side-nav-search">
  39         <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  40         <div role="search">
  41   <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  42     <input type="text" name="q" placeholder="Search docs" />
  43   </form>
  44 </div>
  45       </div>
  46
  47       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  48         <ul class="current">
  49
  50
  51             <li class="toctree-l1">
  52
  53     <a class="" href="..">Home</a>
  54             </li>
  55
  56             <li class="toctree-l1">
  57
  58     <span class="caption-text">Setup</span>
  59     <ul class="subnav">
  60                 <li class="">
  61
  62     <a class="" href="../Download-and-Installation/">Download and Installation</a>
  63                 </li>
  64                 <li class="">
  65
  66     <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  67                 </li>
  68                 <li class="">
  69
  70     <a class="" href="../Server-requirements/">Server requirements</a>
  71                 </li>
  72                 <li class="">
  73
  74     <a class="" href="../Server-configuration/">Server configuration</a>
  75                 </li>
  76                 <li class="">
  77
  78     <a class="" href="../Server-security/">Server security</a>
  79                 </li>
  80                 <li class="">
  81
  82     <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  83                 </li>
  84                 <li class="">
  85
  86     <a class="" href="../Plugins/">Plugins</a>
  87                 </li>
  88     </ul>
  89             </li>
  90
  91             <li class="toctree-l1">
  92
  93     <span class="caption-text">Docker</span>
  94     <ul class="subnav">
  95                 <li class="">
  96
  97     <a class="" href="../docker/docker-101/">Docker 101</a>
  98                 </li>
  99                 <li class="">
 100
 101     <a class="" href="../docker/shaarli-images/">Shaarli images</a>
 102                 </li>
 103                 <li class="">
 104
 105     <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
 106                 </li>
 107                 <li class="">
 108
 109     <a class="" href="../docker/resources/">Docker resources</a>
 110                 </li>
 111     </ul>
 112             </li>
 113
 114             <li class="toctree-l1">
 115
 116     <span class="caption-text">Usage</span>
 117     <ul class="subnav">
 118                 <li class="">
 119
 120     <a class="" href="../Features/">Features</a>
 121                 </li>
 122                 <li class="">
 123
 124     <a class="" href="../Bookmarklet/">Bookmarklet</a>
 125                 </li>
 126                 <li class="">
 127
 128     <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
 129                 </li>
 130                 <li class="">
 131
 132     <a class="" href="../Firefox-share/">Firefox share</a>
 133                 </li>
 134                 <li class="">
 135
 136     <a class="" href="../RSS-feeds/">RSS feeds</a>
 137                 </li>
 138                 <li class="">
 139
 140     <a class="" href="../REST-API/">REST API</a>
 141                 </li>
 142     </ul>
 143             </li>
 144
 145             <li class="toctree-l1">
 146
 147     <span class="caption-text">How To</span>
 148     <ul class="subnav">
 149                 <li class="">
 150
 151     <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
 152                 </li>
 153                 <li class="">
 154
 155     <a class="" href="../Various-hacks/">Various hacks</a>
 156                 </li>
 157     </ul>
 158             </li>
 159
 160             <li class="toctree-l1">
 161
 162     <a class="" href="../Troubleshooting/">Troubleshooting</a>
 163             </li>
 164
 165             <li class="toctree-l1">
 166
 167     <span class="caption-text">Development</span>
 168     <ul class="subnav">
 169                 <li class="">
 170
 171     <a class="" href="../Development-guidelines/">Development guidelines</a>
 172                 </li>
 173                 <li class="">
 174
 175     <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
 176                 </li>
 177                 <li class="">
 178
 179     <a class="" href="../GnuPG-signature/">GnuPG signature</a>
 180                 </li>
 181                 <li class=" current">
 182
 183     <a class="current" href="./">Coding guidelines</a>
 184     <ul class="subnav">
 185
 186     <li class="toctree-l3"><a href="#wip">WIP</a></li>
 187
 188
 189     </ul>
 190                 </li>
 191                 <li class="">
 192
 193     <a class="" href="../Directory-structure/">Directory structure</a>
 194                 </li>
 195                 <li class="">
 196
 197     <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
 198                 </li>
 199                 <li class="">
 200
 201     <a class="" href="../Plugin-System/">Plugin System</a>
 202                 </li>
 203                 <li class="">
 204
 205     <a class="" href="../Release-Shaarli/">Release Shaarli</a>
 206                 </li>
 207                 <li class="">
 208
 209     <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
 210                 </li>
 211                 <li class="">
 212
 213     <a class="" href="../Security/">Security</a>
 214                 </li>
 215                 <li class="">
 216
 217     <a class="" href="../Static-analysis/">Static analysis</a>
 218                 </li>
 219                 <li class="">
 220
 221     <a class="" href="../Theming/">Theming</a>
 222                 </li>
 223                 <li class="">
 224
 225     <a class="" href="../Unit-tests/">Unit tests</a>
 226                 </li>
 227     </ul>
 228             </li>
 229
 230             <li class="toctree-l1">
 231
 232     <span class="caption-text">About</span>
 233     <ul class="subnav">
 234                 <li class="">
 235
 236     <a class="" href="../FAQ/">FAQ</a>
 237                 </li>
 238                 <li class="">
 239
 240     <a class="" href="../Community-&-Related-software/">Community & Related software</a>
 241                 </li>
 242     </ul>
 243             </li>
 244
 245         </ul>
 246       </div>
 247       &nbsp;
 248     </nav>
 249
 250     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 251
 252
 253       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 254         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 255         <a href="..">Shaarli Documentation</a>
 256       </nav>
 257
 258
 259       <div class="wy-nav-content">
 260         <div class="rst-content">
 261           <div role="navigation" aria-label="breadcrumbs navigation">
 262   <ul class="wy-breadcrumbs">
 263     <li><a href="..">Docs</a> &raquo;</li>
 264
 265
 266
 267           <li>Development &raquo;</li>
 268
 269
 270
 271     <li>Coding guidelines</li>
 272     <li class="wy-breadcrumbs-aside">
 273
 274         <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Coding-guidelines.md"
 275           class="icon icon-github"> Edit on GitHub</a>
 276
 277     </li>
 278   </ul>
 279   <hr/>
 280 </div>
 281           <div role="main">
 282             <div class="section">
 283
 284                 <h2 id="wip">WIP</h2>
 285 <p>This topic is currently being discussed here:
 286 - <a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)
 287 - <a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools &amp; features</a> (#130)</p>
 288
 289             </div>
 290           </div>
 291           <footer>
 292
 293     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 294
 295         <a href="../Directory-structure/" class="btn btn-neutral float-right" title="Directory structure">Next <span class="icon icon-circle-arrow-right"></span></a>
 296
 297
 298         <a href="../GnuPG-signature/" class="btn btn-neutral" title="GnuPG signature"><span class="icon icon-circle-arrow-left"></span> Previous</a>
 299
 300     </div>
 301
 302
 303   <hr/>
 304
 305   <div role="contentinfo">
 306     <!-- Copyright etc -->
 307
 308   </div>
 309
 310   Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 311 </footer>
 312
 313         </div>
 314       </div>
 315
 316     </section>
 317
 318   </div>
 319
 320   <div class="rst-versions" role="note" style="cursor: pointer">
 321     <span class="rst-current-version" data-toggle="rst-current-version">
 322
 323           <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
 324
 325
 326         <span><a href="../GnuPG-signature/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 327
 328
 329         <span style="margin-left: 15px"><a href="../Directory-structure/" style="color: #fcfcfc">Next &raquo;</a></span>
 330
 331     </span>
 332 </div>
 333     <script src="../js/theme.js"></script>
 334
 335 </body>
 336 </html>