Browse Source

First draft for the documents

Bastien 2 years ago
parent
commit
9db1e20296

+ 3 - 0
.gitignore

@@ -0,0 +1,3 @@
1
+*el
2
+*setup
3
+html/

+ 145 - 0
data/styles/readtheorg/css/htmlize.css

@@ -0,0 +1,145 @@
1
+.org-bold { /* bold */ font-weight: bold; }
2
+.org-bold-italic { /* bold-italic */ font-weight: bold; font-style: italic; }
3
+.org-buffer-menu-buffer { /* buffer-menu-buffer */ font-weight: bold; }
4
+.org-builtin { /* font-lock-builtin-face */ color: #7a378b; }
5
+.org-button { /* button */ text-decoration: underline; }
6
+.org-calendar-today { /* calendar-today */ text-decoration: underline; }
7
+.org-change-log-acknowledgement { /* change-log-acknowledgement */ color: #b22222; }
8
+.org-change-log-conditionals { /* change-log-conditionals */ color: #a0522d; }
9
+.org-change-log-date { /* change-log-date */ color: #8b2252; }
10
+.org-change-log-email { /* change-log-email */ color: #a0522d; }
11
+.org-change-log-file { /* change-log-file */ color: #0000ff; }
12
+.org-change-log-function { /* change-log-function */ color: #a0522d; }
13
+.org-change-log-list { /* change-log-list */ color: #a020f0; }
14
+.org-change-log-name { /* change-log-name */ color: #008b8b; }
15
+.org-comint-highlight-input { /* comint-highlight-input */ font-weight: bold; }
16
+.org-comint-highlight-prompt { /* comint-highlight-prompt */ color: #00008b; }
17
+.org-comment { /* font-lock-comment-face */ color: #999988; font-style: italic; }
18
+.org-comment-delimiter { /* font-lock-comment-delimiter-face */ color: #999988; font-style: italic; }
19
+.org-completions-annotations { /* completions-annotations */ font-style: italic; }
20
+.org-completions-common-part { /* completions-common-part */ color: #000000; background-color: #ffffff; }
21
+.org-completions-first-difference { /* completions-first-difference */ font-weight: bold; }
22
+.org-constant { /* font-lock-constant-face */ color: #008b8b; }
23
+.org-diary { /* diary */ color: #ff0000; }
24
+.org-diff-context { /* diff-context */ color: #7f7f7f; }
25
+.org-diff-file-header { /* diff-file-header */ background-color: #b3b3b3; font-weight: bold; }
26
+.org-diff-function { /* diff-function */ background-color: #cccccc; }
27
+.org-diff-header { /* diff-header */ background-color: #cccccc; }
28
+.org-diff-hunk-header { /* diff-hunk-header */ background-color: #cccccc; }
29
+.org-diff-index { /* diff-index */ background-color: #b3b3b3; font-weight: bold; }
30
+.org-diff-nonexistent { /* diff-nonexistent */ background-color: #b3b3b3; font-weight: bold; }
31
+.org-diff-refine-change { /* diff-refine-change */ background-color: #d9d9d9; }
32
+.org-dired-directory { /* dired-directory */ color: #0000ff; }
33
+.org-dired-flagged { /* dired-flagged */ color: #ff0000; font-weight: bold; }
34
+.org-dired-header { /* dired-header */ color: #228b22; }
35
+.org-dired-ignored { /* dired-ignored */ color: #7f7f7f; }
36
+.org-dired-mark { /* dired-mark */ color: #008b8b; }
37
+.org-dired-marked { /* dired-marked */ color: #ff0000; font-weight: bold; }
38
+.org-dired-perm-write { /* dired-perm-write */ color: #b22222; }
39
+.org-dired-symlink { /* dired-symlink */ color: #a020f0; }
40
+.org-dired-warning { /* dired-warning */ color: #ff0000; font-weight: bold; }
41
+.org-doc { /* font-lock-doc-face */ color: #8b2252; }
42
+.org-escape-glyph { /* escape-glyph */ color: #a52a2a; }
43
+.org-file-name-shadow { /* file-name-shadow */ color: #7f7f7f; }
44
+.org-flyspell-duplicate { /* flyspell-duplicate */ color: #cdad00; font-weight: bold; text-decoration: underline; }
45
+.org-flyspell-incorrect { /* flyspell-incorrect */ color: #ff4500; font-weight: bold; text-decoration: underline; }
46
+.org-fringe { /* fringe */ background-color: #f2f2f2; }
47
+.org-function-name { /* font-lock-function-name-face */ color: teal; }
48
+.org-header-line { /* header-line */ color: #333333; background-color: #e5e5e5; }
49
+.org-help-argument-name { /* help-argument-name */ font-style: italic; }
50
+.org-highlight { /* highlight */ background-color: #b4eeb4; }
51
+.org-holiday { /* holiday */ background-color: #ffc0cb; }
52
+.org-isearch { /* isearch */ color: #b0e2ff; background-color: #cd00cd; }
53
+.org-isearch-fail { /* isearch-fail */ background-color: #ffc1c1; }
54
+.org-italic { /* italic */ font-style: italic; }
55
+.org-keyword { /* font-lock-keyword-face */ color: #0086b3; }
56
+.org-lazy-highlight { /* lazy-highlight */ background-color: #afeeee; }
57
+.org-link { /* link */ color: #0000ff; text-decoration: underline; }
58
+.org-link-visited { /* link-visited */ color: #8b008b; text-decoration: underline; }
59
+.org-log-edit-header { /* log-edit-header */ color: #a020f0; }
60
+.org-log-edit-summary { /* log-edit-summary */ color: #0000ff; }
61
+.org-log-edit-unknown-header { /* log-edit-unknown-header */ color: #b22222; }
62
+.org-match { /* match */ background-color: #ffff00; }
63
+.org-next-error { /* next-error */ background-color: #eedc82; }
64
+.org-nobreak-space { /* nobreak-space */ color: #a52a2a; text-decoration: underline; }
65
+.org-org-archived { /* org-archived */ color: #7f7f7f; }
66
+.org-org-block { /* org-block */ color: #7f7f7f; }
67
+.org-org-block-begin-line { /* org-block-begin-line */ color: #b22222; }
68
+.org-org-block-end-line { /* org-block-end-line */ color: #b22222; }
69
+.org-org-checkbox { /* org-checkbox */ font-weight: bold; }
70
+.org-org-checkbox-statistics-done { /* org-checkbox-statistics-done */ color: #228b22; font-weight: bold; }
71
+.org-org-checkbox-statistics-todo { /* org-checkbox-statistics-todo */ color: #ff0000; font-weight: bold; }
72
+.org-org-clock-overlay { /* org-clock-overlay */ background-color: #ffff00; }
73
+.org-org-code { /* org-code */ color: #7f7f7f; }
74
+.org-org-column { /* org-column */ background-color: #e5e5e5; }
75
+.org-org-column-title { /* org-column-title */ background-color: #e5e5e5; font-weight: bold; text-decoration: underline; }
76
+.org-org-date { /* org-date */ color: #a020f0; text-decoration: underline; }
77
+.org-org-document-info { /* org-document-info */ color: #191970; }
78
+.org-org-document-info-keyword { /* org-document-info-keyword */ color: #7f7f7f; }
79
+.org-org-document-title { /* org-document-title */ color: #191970; font-size: 144%; font-weight: bold; }
80
+.org-org-done { /* org-done */ color: #228b22; font-weight: bold; }
81
+.org-org-drawer { /* org-drawer */ color: #0000ff; }
82
+.org-org-ellipsis { /* org-ellipsis */ color: #b8860b; text-decoration: underline; }
83
+.org-org-footnote { /* org-footnote */ color: #a020f0; text-decoration: underline; }
84
+.org-org-formula { /* org-formula */ color: #b22222; }
85
+.org-org-headline-done { /* org-headline-done */ color: #bc8f8f; }
86
+.org-org-hide { /* org-hide */ color: #ffffff; }
87
+.org-org-latex-and-export-specials { /* org-latex-and-export-specials */ color: #8b4513; }
88
+.org-org-level-1 { /* org-level-1 */ color: #0000ff; }
89
+.org-org-level-2 { /* org-level-2 */ color: #a0522d; }
90
+.org-org-level-3 { /* org-level-3 */ color: #a020f0; }
91
+.org-org-level-4 { /* org-level-4 */ color: #b22222; }
92
+.org-org-level-5 { /* org-level-5 */ color: #228b22; }
93
+.org-org-level-6 { /* org-level-6 */ color: #008b8b; }
94
+.org-org-level-7 { /* org-level-7 */ color: #7a378b; }
95
+.org-org-level-8 { /* org-level-8 */ color: #8b2252; }
96
+.org-org-link { /* org-link */ color: #0000ff; text-decoration: underline; }
97
+.org-org-meta-line { /* org-meta-line */ color: #b22222; }
98
+.org-org-mode-line-clock { /* org-mode-line-clock */ color: #000000; background-color: #bfbfbf; }
99
+.org-org-mode-line-clock-overrun { /* org-mode-line-clock-overrun */ color: #000000; background-color: #ff0000; }
100
+.org-org-quote { /* org-quote */ color: #7f7f7f; }
101
+.org-org-scheduled { /* org-scheduled */ color: #006400; }
102
+.org-org-scheduled-previously { /* org-scheduled-previously */ color: #b22222; }
103
+.org-org-scheduled-today { /* org-scheduled-today */ color: #006400; }
104
+.org-org-sexp-date { /* org-sexp-date */ color: #a020f0; }
105
+.org-org-special-keyword { /* org-special-keyword */ color: #a020f0; }
106
+.org-org-table { /* org-table */ color: #0000ff; }
107
+.org-org-tag { /* org-tag */ font-weight: bold; }
108
+.org-org-target { /* org-target */ text-decoration: underline; }
109
+.org-org-time-grid { /* org-time-grid */ color: #b8860b; }
110
+.org-org-todo { /* org-todo */ color: #ff0000; font-weight: bold; }
111
+.org-org-upcoming-deadline { /* org-upcoming-deadline */ color: #b22222; }
112
+.org-org-verbatim { /* org-verbatim */ color: #7f7f7f; }
113
+.org-org-verse { /* org-verse */ color: #7f7f7f; }
114
+.org-org-warning { /* org-warning */ color: #ff0000; font-weight: bold; }
115
+.org-outline-1 { /* outline-1 */ color: #0000ff; }
116
+.org-outline-2 { /* outline-2 */ color: #a0522d; }
117
+.org-outline-3 { /* outline-3 */ color: #a020f0; }
118
+.org-outline-4 { /* outline-4 */ color: #b22222; }
119
+.org-outline-5 { /* outline-5 */ color: #228b22; }
120
+.org-outline-6 { /* outline-6 */ color: #008b8b; }
121
+.org-outline-7 { /* outline-7 */ color: #7a378b; }
122
+.org-outline-8 { /* outline-8 */ color: #8b2252; }
123
+.org-preprocessor { /* font-lock-preprocessor-face */ color: #7a378b; }
124
+.org-query-replace { /* query-replace */ color: #b0e2ff; background-color: #cd00cd; }
125
+.org-regexp-grouping-backslash { /* font-lock-regexp-grouping-backslash */ font-weight: bold; }
126
+.org-regexp-grouping-construct { /* font-lock-regexp-grouping-construct */ font-weight: bold; }
127
+.org-region { /* region */ background-color: #eedc82; }
128
+.org-secondary-selection { /* secondary-selection */ background-color: #ffff00; }
129
+.org-shadow { /* shadow */ color: #7f7f7f; }
130
+.org-show-paren-match { /* show-paren-match */ background-color: #40e0d0; }
131
+.org-show-paren-mismatch { /* show-paren-mismatch */ color: #ffffff; background-color: #a020f0; }
132
+.org-string { /* font-lock-string-face */ color: #dd1144; }
133
+.org-tool-bar { /* tool-bar */ color: #000000; background-color: #bfbfbf; }
134
+.org-tooltip { /* tooltip */ color: #000000; background-color: #ffffe0; }
135
+.org-trailing-whitespace { /* trailing-whitespace */ background-color: #ff0000; }
136
+.org-type { /* font-lock-type-face */ color: #228b22; }
137
+.org-underline { /* underline */ text-decoration: underline; }
138
+.org-variable-name { /* font-lock-variable-name-face */ color: teal; }
139
+.org-warning { /* font-lock-warning-face */ color: #ff0000; font-weight: bold; }
140
+.org-widget-button { /* widget-button */ font-weight: bold; }
141
+.org-widget-button-pressed { /* widget-button-pressed */ color: #ff0000; }
142
+.org-widget-documentation { /* widget-documentation */ color: #006400; }
143
+.org-widget-field { /* widget-field */ background-color: #d9d9d9; }
144
+.org-widget-inactive { /* widget-inactive */ color: #7f7f7f; }
145
+.org-widget-single-line-field { /* widget-single-line-field */ background-color: #d9d9d9; }

File diff suppressed because it is too large
+ 1085 - 0
data/styles/readtheorg/css/readtheorg.css


File diff suppressed because it is too large
+ 3910 - 0
data/styles/readtheorg/css/rtd-full.css


+ 86 - 0
data/styles/readtheorg/js/readtheorg.js

@@ -0,0 +1,86 @@
1
+
2
+$(function() {
3
+    $('.note').before("<p class='admonition-title note'>Note</p>");
4
+    $('.seealso').before("<p class='admonition-title seealso'>See also</p>");
5
+    $('.warning').before("<p class='admonition-title warning'>Warning</p>");
6
+    $('.caution').before("<p class='admonition-title caution'>Caution</p>");
7
+    $('.attention').before("<p class='admonition-title attention'>Attention</p>");
8
+    $('.tip').before("<p class='admonition-title tip'>Tip</p>");
9
+    $('.important').before("<p class='admonition-title important'>Important</p>");
10
+    $('.hint').before("<p class='admonition-title hint'>Hint</p>");
11
+    $('.error').before("<p class='admonition-title error'>Error</p>");
12
+    $('.danger').before("<p class='admonition-title danger'>Danger</p>");
13
+});
14
+
15
+$( document ).ready(function() {
16
+
17
+    // Shift nav in mobile when clicking the menu.
18
+    $(document).on('click', "[data-toggle='wy-nav-top']", function() {
19
+      $("[data-toggle='wy-nav-shift']").toggleClass("shift");
20
+      $("[data-toggle='rst-versions']").toggleClass("shift");
21
+    });
22
+    // Close menu when you click a link.
23
+    $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
24
+      $("[data-toggle='wy-nav-shift']").removeClass("shift");
25
+      $("[data-toggle='rst-versions']").toggleClass("shift");
26
+    });
27
+    $(document).on('click', "[data-toggle='rst-current-version']", function() {
28
+      $("[data-toggle='rst-versions']").toggleClass("shift-up");
29
+    });
30
+    // Make tables responsive
31
+    $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
32
+});
33
+
34
+$( document ).ready(function() {
35
+    $('#text-table-of-contents ul').first().addClass('nav');
36
+                                        // ScrollSpy also requires that we use
37
+                                        // a Bootstrap nav component.
38
+    $('body').scrollspy({target: '#text-table-of-contents'});
39
+
40
+    // add sticky table headers
41
+    $('table').stickyTableHeaders();
42
+
43
+    // set the height of tableOfContents
44
+    var $postamble = $('#postamble');
45
+    var $tableOfContents = $('#table-of-contents');
46
+    $tableOfContents.css({paddingBottom: $postamble.outerHeight()});
47
+
48
+    // add TOC button
49
+    var toggleSidebar = $('<div id="toggle-sidebar"><a href="#table-of-contents"><h2>Table of Contents</h2></a></div>');
50
+    $('#content').prepend(toggleSidebar);
51
+
52
+    // add close button when sidebar showed in mobile screen
53
+    var closeBtn = $('<a class="close-sidebar" href="#">Close</a>');
54
+    var tocTitle = $('#table-of-contents').find('h2');
55
+    tocTitle.append(closeBtn);
56
+});
57
+
58
+window.SphinxRtdTheme = (function (jquery) {
59
+    var stickyNav = (function () {
60
+        var navBar,
61
+            win,
62
+            stickyNavCssClass = 'stickynav',
63
+            applyStickNav = function () {
64
+                if (navBar.height() <= win.height()) {
65
+                    navBar.addClass(stickyNavCssClass);
66
+                } else {
67
+                    navBar.removeClass(stickyNavCssClass);
68
+                }
69
+            },
70
+            enable = function () {
71
+                applyStickNav();
72
+                win.on('resize', applyStickNav);
73
+            },
74
+            init = function () {
75
+                navBar = jquery('nav.wy-nav-side:first');
76
+                win    = jquery(window);
77
+            };
78
+        jquery(init);
79
+        return {
80
+            enable : enable
81
+        };
82
+    }());
83
+    return {
84
+        StickyNav : stickyNav
85
+    };
86
+}($));

+ 0 - 0
faq.org


+ 1 - 0
guide-du-contributeur.org

@@ -0,0 +1 @@
1
+#+TITLE: Guide du contributeur

+ 28 - 0
index.org

@@ -0,0 +1,28 @@
1
+#+TITLE: Inventaire des orgues - documentation
2
+#+SETUPFILE: theme-readtheorg-local.setup
3
+#+OPTIONS: toc:t
4
+
5
+* TODO Présentation du site inventaire-des-orgues.fr
6
+
7
+La [[file:presentation-site.org][présentation]] fait un tour rapide des pages web accessibles
8
+depuis le site [[http://www.inventaire-des-orgues.fr][www.inventaire-des-orgues.fr]].
9
+
10
+* TODO Guide du contributeur
11
+
12
+Le [[file:guide-du-contributeur.org][guide du contributeur]] présente les différentes façons dont les
13
+contributeurs peuvent participer au projet.
14
+
15
+* TODO Manuel d'utilisation de l'application web
16
+
17
+Le [[file:manuel-utilisateur.org][manuel d'utilisation]] fait le tour des différentes fonctionnalités
18
+de l'application web du point de vue de l'utilisateur.
19
+
20
+* TODO Manuel du développeur de l'application web
21
+
22
+Le [[file:manuel-developpeur.org][manuel du développeur]] fait le tour des différentes fonctionnalités
23
+de l'application web du point de vue de l'utilisateur.
24
+
25
+* TODO Foire aux questions
26
+
27
+La [[file:faq.org][foire aux questions]] généraliste répond aux
28
+questions posées par les contributeurs au fur et à mesure.

+ 1 - 0
manuel-developpeur.org

@@ -0,0 +1 @@
1
+#+TITLE: Manuel du développeur

+ 1 - 0
manuel-utilisateur.org

@@ -0,0 +1 @@
1
+#+TITLE: Manuel de l'utilisateur

+ 1 - 0
presentation-site.org

@@ -0,0 +1 @@
1
+#+TITLE: Présentation du site

+ 0 - 0
theindex.inc


+ 4 - 0
theindex.org

@@ -0,0 +1,4 @@
1
+#+TITLE: Index
2
+
3
+#+INCLUDE: "theindex.inc"
4
+