diff options
author | nodiscc <nodiscc@gmail.com> | 2017-07-04 21:37:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-04 21:37:30 +0200 |
commit | 5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch) | |
tree | d5c46525f3c739d9c63de860427e0b3cadd688e5 /doc/html/Development-guidelines | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
parent | 8bf94136e10c64496711c8f66a4f58f89c515360 (diff) | |
download | Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip |
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'doc/html/Development-guidelines')
-rw-r--r-- | doc/html/Development-guidelines/index.html | 340 |
1 files changed, 340 insertions, 0 deletions
diff --git a/doc/html/Development-guidelines/index.html b/doc/html/Development-guidelines/index.html new file mode 100644 index 00000000..e75c911b --- /dev/null +++ b/doc/html/Development-guidelines/index.html | |||
@@ -0,0 +1,340 @@ | |||
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>Development 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 = "Development guidelines"; | ||
22 | var mkdocs_page_input_path = "Development-guidelines.md"; | ||
23 | var mkdocs_page_url = "/Development-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-101/">Docker 101</a> | ||
98 | </li> | ||
99 | <li class=""> | ||
100 | |||
101 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
102 | </li> | ||
103 | <li class=""> | ||
104 | |||
105 | <a class="" href="../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=" current"> | ||
170 | |||
171 | <a class="current" href="./">Development guidelines</a> | ||
172 | <ul class="subnav"> | ||
173 | |||
174 | <li class="toctree-l3"><a href="#development-guidelines">Development guidelines</a></li> | ||
175 | |||
176 | |||
177 | </ul> | ||
178 | </li> | ||
179 | <li class=""> | ||
180 | |||
181 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
182 | </li> | ||
183 | <li class=""> | ||
184 | |||
185 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
186 | </li> | ||
187 | <li class=""> | ||
188 | |||
189 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
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 | | ||
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> »</li> | ||
264 | |||
265 | |||
266 | |||
267 | <li>Development »</li> | ||
268 | |||
269 | |||
270 | |||
271 | <li>Development guidelines</li> | ||
272 | <li class="wy-breadcrumbs-aside"> | ||
273 | |||
274 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Development-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="development-guidelines">Development guidelines</h2> | ||
285 | <p>Please have a look at the following pages: | ||
286 | - <a href="https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md">Contributing to Shaarli</a> | ||
287 | - <a href="../Static analysis">Static analysis</a> - patches should try to stick to the <a href="http://www.php-fig.org/psr/">PHP Standard Recommendations</a> (PSR), especially: | ||
288 | - <a href="http://www.php-fig.org/psr/psr-1/">PSR-1</a> - Basic Coding Standard | ||
289 | - <a href="http://www.php-fig.org/psr/psr-2/">PSR-2</a> - Coding Style Guide | ||
290 | - <a href="../Unit tests">Unit tests</a> | ||
291 | - <a href="../GnuPG signature">GnuPG signature</a> for tags/releases</p> | ||
292 | |||
293 | </div> | ||
294 | </div> | ||
295 | <footer> | ||
296 | |||
297 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
298 | |||
299 | <a href="../Continuous-integration-tools/" class="btn btn-neutral float-right" title="Continuous integration tools">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
300 | |||
301 | |||
302 | <a href="../Troubleshooting/" class="btn btn-neutral" title="Troubleshooting"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
303 | |||
304 | </div> | ||
305 | |||
306 | |||
307 | <hr/> | ||
308 | |||
309 | <div role="contentinfo"> | ||
310 | <!-- Copyright etc --> | ||
311 | |||
312 | </div> | ||
313 | |||
314 | 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>. | ||
315 | </footer> | ||
316 | |||
317 | </div> | ||
318 | </div> | ||
319 | |||
320 | </section> | ||
321 | |||
322 | </div> | ||
323 | |||
324 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
325 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
326 | |||
327 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
328 | |||
329 | |||
330 | <span><a href="../Troubleshooting/" style="color: #fcfcfc;">« Previous</a></span> | ||
331 | |||
332 | |||
333 | <span style="margin-left: 15px"><a href="../Continuous-integration-tools/" style="color: #fcfcfc">Next »</a></span> | ||
334 | |||
335 | </span> | ||
336 | </div> | ||
337 | <script src="../js/theme.js"></script> | ||
338 | |||
339 | </body> | ||
340 | </html> | ||