Peter M. Groen / openbr

Commit 8d42271f3a3e6389c6393978364c0f7542a8fd33

Authored by Jordan Cheney
1 parent 7efc13c8

Update website structure to reflect removed files also add docs script and instructions

Inline Side-by-side
Showing 3 changed files with 19 additions and 37 deletions
docs/DOCS.md 0 → 100644
  View file @8d42271
  1 +# OpenBR Documentation Guide
  2 +
  3 +This is a quick guide for generating the OpenBR documentation on your local machine. The documentation is available online at www.openbiometrics.org.
  4 +
  5 +OpenBR's documentation is built with MkDocs. Please see their website for additional information at www.mkdocs.org. Installing mkdocs with pip is super easy-
  6 +
  7 + $ pip install mkdocs
  8 +
  9 +Please note that you need Python 2.7 and above already installed. Once mkdocs is installed you can run build_docs.sh to build static html pages at openbr/docs/site. However, for viewing we recommend serving the docs to your browser using a simple http server. Run
  10 +
  11 + $ mkdocs serve
  12 +
  13 +from openbr/docs and then go to http://127.0.0.1:8000 in your internet browser of choice to view the docs locally.
docs/build_docs.sh 0 → 100644
  View file @8d42271
  1 +# Build the OpenBR documentation as static html
  2 +#
  3 +# NOTE: This requires mkdocs to be installed. Please see DOCS.md file for
  4 +# instructions
  5 +
  6 +mkdocs build
docs/mkdocs.yml
  View file @8d42271
@@ -20,7 +20,6 @@ pages: @@ -20,7 +20,6 @@ pages:
20 - [install.md, Install] 20 - [install.md, Install]
21 - [tutorials.md, Tutorials] 21 - [tutorials.md, Tutorials]
22 - [contribute.md, Contribute] 22 - [contribute.md, Contribute]
23 -- [papers.md, Publications]  
24 23
25 # C API 24 # C API
26 - [api_docs/c_api.md, API Docs, C API] 25 - [api_docs/c_api.md, API Docs, C API]
@@ -41,7 +40,6 @@ pages: @@ -41,7 +40,6 @@ pages:
41 40
42 # FileList 41 # FileList
43 - [api_docs/cpp_api/filelist/filelist.md, C++ Plugin API, FileList] 42 - [api_docs/cpp_api/filelist/filelist.md, C++ Plugin API, FileList]
44 -- [api_docs/cpp_api/filelist/members.md, FileList, Members]  
45 - [api_docs/cpp_api/filelist/constructors.md, FileList, Constructors] 43 - [api_docs/cpp_api/filelist/constructors.md, FileList, Constructors]
46 - [api_docs/cpp_api/filelist/statics.md, FileList, Static Functions] 44 - [api_docs/cpp_api/filelist/statics.md, FileList, Static Functions]
47 - [api_docs/cpp_api/filelist/functions.md, FileList, Functions] 45 - [api_docs/cpp_api/filelist/functions.md, FileList, Functions]
@@ -55,7 +53,6 @@ pages: @@ -55,7 +53,6 @@ pages:
55 53
56 # TemplateList 54 # TemplateList
57 - [api_docs/cpp_api/templatelist/templatelist.md, C++ Plugin API, TemplateList] 55 - [api_docs/cpp_api/templatelist/templatelist.md, C++ Plugin API, TemplateList]
58 -- [api_docs/cpp_api/templatelist/members.md, TemplateList, Members]  
59 - [api_docs/cpp_api/templatelist/constructors.md, TemplateList, Constructors] 56 - [api_docs/cpp_api/templatelist/constructors.md, TemplateList, Constructors]
60 - [api_docs/cpp_api/templatelist/statics.md, TemplateList, Static Functions] 57 - [api_docs/cpp_api/templatelist/statics.md, TemplateList, Static Functions]
61 - [api_docs/cpp_api/templatelist/functions.md, TemplateList, Functions] 58 - [api_docs/cpp_api/templatelist/functions.md, TemplateList, Functions]
@@ -66,12 +63,10 @@ pages: @@ -66,12 +63,10 @@ pages:
66 - [api_docs/cpp_api/factory/constructors.md, Factory, Constructors] 63 - [api_docs/cpp_api/factory/constructors.md, Factory, Constructors]
67 - [api_docs/cpp_api/factory/macros.md, Factory, Macros] 64 - [api_docs/cpp_api/factory/macros.md, Factory, Macros]
68 - [api_docs/cpp_api/factory/statics.md, Factory, Static Functions] 65 - [api_docs/cpp_api/factory/statics.md, Factory, Static Functions]
69 -- [api_docs/cpp_api/factory/functions.md, Factory, Functions]  
70 66
71 # Object 67 # Object
72 - [api_docs/cpp_api/object/object.md, C++ Plugin API, Object] 68 - [api_docs/cpp_api/object/object.md, C++ Plugin API, Object]
73 - [api_docs/cpp_api/object/members.md, Object, Members] 69 - [api_docs/cpp_api/object/members.md, Object, Members]
74 -- [api_docs/cpp_api/object/constructors.md, Object, Constructors]  
75 - [api_docs/cpp_api/object/macros.md, Object, Macros] 70 - [api_docs/cpp_api/object/macros.md, Object, Macros]
76 - [api_docs/cpp_api/object/statics.md, Object, Static Functions] 71 - [api_docs/cpp_api/object/statics.md, Object, Static Functions]
77 - [api_docs/cpp_api/object/functions.md, Object, Functions] 72 - [api_docs/cpp_api/object/functions.md, Object, Functions]
@@ -79,15 +74,12 @@ pages: @@ -79,15 +74,12 @@ pages:
79 # Context 74 # Context
80 - [api_docs/cpp_api/context/context.md, C++ Plugin API, Context] 75 - [api_docs/cpp_api/context/context.md, C++ Plugin API, Context]
81 - [api_docs/cpp_api/context/members.md, Context, Members] 76 - [api_docs/cpp_api/context/members.md, Context, Members]
82 -- [api_docs/cpp_api/context/constructors.md, Context, Constructors]  
83 - [api_docs/cpp_api/context/statics.md, Context, Static Functions] 77 - [api_docs/cpp_api/context/statics.md, Context, Static Functions]
84 - [api_docs/cpp_api/context/functions.md, Context, Functions] 78 - [api_docs/cpp_api/context/functions.md, Context, Functions]
85 79
86 # Initializer 80 # Initializer
87 - [api_docs/cpp_api/initializer/initializer.md, C++ Plugin API, Initializer] 81 - [api_docs/cpp_api/initializer/initializer.md, C++ Plugin API, Initializer]
88 -- [api_docs/cpp_api/initializer/members.md, Initializer, Members]  
89 - [api_docs/cpp_api/initializer/constructors.md, Initializer, Constructors] 82 - [api_docs/cpp_api/initializer/constructors.md, Initializer, Constructors]
90 -- [api_docs/cpp_api/initializer/statics.md, Initializer, Static Functions]  
91 - [api_docs/cpp_api/initializer/functions.md, Initializer, Functions] 83 - [api_docs/cpp_api/initializer/functions.md, Initializer, Functions]
92 84
93 # Transform 85 # Transform
@@ -99,44 +91,29 @@ pages: @@ -99,44 +91,29 @@ pages:
99 91
100 # UntrainableTransform 92 # UntrainableTransform
101 - [api_docs/cpp_api/untrainabletransform/untrainabletransform.md, C++ Plugin API, UntrainableTransform] 93 - [api_docs/cpp_api/untrainabletransform/untrainabletransform.md, C++ Plugin API, UntrainableTransform]
102 -- [api_docs/cpp_api/untrainabletransform/members.md, UntrainableTransform, Members]  
103 - [api_docs/cpp_api/untrainabletransform/constructors.md, UntrainableTransform, Constructors] 94 - [api_docs/cpp_api/untrainabletransform/constructors.md, UntrainableTransform, Constructors]
104 -- [api_docs/cpp_api/untrainabletransform/statics.md, UntrainableTransform, Static Functions]  
105 -- [api_docs/cpp_api/untrainabletransform/functions.md, UntrainableTransform, Functions]  
106 95
107 # MetaTransform 96 # MetaTransform
108 - [api_docs/cpp_api/metatransform/metatransform.md, C++ Plugin API, MetaTransform] 97 - [api_docs/cpp_api/metatransform/metatransform.md, C++ Plugin API, MetaTransform]
109 -- [api_docs/cpp_api/metatransform/members.md, MetaTransform, Members]  
110 - [api_docs/cpp_api/metatransform/constructors.md, MetaTransform, Constructors] 98 - [api_docs/cpp_api/metatransform/constructors.md, MetaTransform, Constructors]
111 -- [api_docs/cpp_api/metatransform/statics.md, MetaTransform, Static Functions]  
112 -- [api_docs/cpp_api/metatransform/functions.md, MetaTransform, Functions]  
113 99
114 # UntrainableMetaTransform 100 # UntrainableMetaTransform
115 - [api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md, C++ Plugin API, UntrainableMetaTransform] 101 - [api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md, C++ Plugin API, UntrainableMetaTransform]
116 -- [api_docs/cpp_api/untrainablemetatransform/members.md, UntrainableMetaTransform, Members]  
117 - [api_docs/cpp_api/untrainablemetatransform/constructors.md, UntrainableMetaTransform, Constructors] 102 - [api_docs/cpp_api/untrainablemetatransform/constructors.md, UntrainableMetaTransform, Constructors]
118 -- [api_docs/cpp_api/untrainablemetatransform/statics.md, UntrainableMetaTransform, Static Functions]  
119 -- [api_docs/cpp_api/untrainablemetatransform/functions.md, UntrainableMetaTransform, Functions]  
120 103
121 # MetadataTransform 104 # MetadataTransform
122 - [api_docs/cpp_api/metadatatransform/metadatatransform.md, C++ Plugin API, MetadataTransform] 105 - [api_docs/cpp_api/metadatatransform/metadatatransform.md, C++ Plugin API, MetadataTransform]
123 -- [api_docs/cpp_api/metadatatransform/members.md, MetadataTransform, Members]  
124 - [api_docs/cpp_api/metadatatransform/constructors.md, MetadataTransform, Constructors] 106 - [api_docs/cpp_api/metadatatransform/constructors.md, MetadataTransform, Constructors]
125 -- [api_docs/cpp_api/metadatatransform/statics.md, MetadataTransform, Static Functions]  
126 - [api_docs/cpp_api/metadatatransform/functions.md, MetadataTransform, Functions] 107 - [api_docs/cpp_api/metadatatransform/functions.md, MetadataTransform, Functions]
127 108
128 # UntrainableMetadataTransform 109 # UntrainableMetadataTransform
129 - [api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md, C++ Plugin API, UntrainableMetadataTransform] 110 - [api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md, C++ Plugin API, UntrainableMetadataTransform]
130 -- [api_docs/cpp_api/untrainablemetadatatransform/members.md, UntrainableMetadataTransform, Members]  
131 - [api_docs/cpp_api/untrainablemetadatatransform/constructors.md, UntrainableMetadataTransform, Constructors] 111 - [api_docs/cpp_api/untrainablemetadatatransform/constructors.md, UntrainableMetadataTransform, Constructors]
132 -- [api_docs/cpp_api/untrainablemetadatatransform/statics.md, UntrainableMetadataTransform, Static Functions]  
133 -- [api_docs/cpp_api/untrainablemetadatatransform/functions.md, UntrainableMetadataTransform, Functions]  
134 112
135 # TimeVaryingTransform 113 # TimeVaryingTransform
136 - [api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md, C++ Plugin API, TimeVaryingTransform] 114 - [api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md, C++ Plugin API, TimeVaryingTransform]
137 - [api_docs/cpp_api/timevaryingtransform/members.md, TimeVaryingTransform, Members] 115 - [api_docs/cpp_api/timevaryingtransform/members.md, TimeVaryingTransform, Members]
138 - [api_docs/cpp_api/timevaryingtransform/constructors.md, TimeVaryingTransform, Constructors] 116 - [api_docs/cpp_api/timevaryingtransform/constructors.md, TimeVaryingTransform, Constructors]
139 -- [api_docs/cpp_api/timevaryingtransform/statics.md, TimeVaryingTransform, Static Functions]  
140 - [api_docs/cpp_api/timevaryingtransform/functions.md, TimeVaryingTransform, Functions] 117 - [api_docs/cpp_api/timevaryingtransform/functions.md, TimeVaryingTransform, Functions]
141 118
142 # CompositeTransform 119 # CompositeTransform
@@ -144,30 +121,22 @@ pages: @@ -144,30 +121,22 @@ pages:
144 - [api_docs/cpp_api/compositetransform/properties.md, CompositeTransform, Properties] 121 - [api_docs/cpp_api/compositetransform/properties.md, CompositeTransform, Properties]
145 - [api_docs/cpp_api/compositetransform/members.md, CompositeTransform, Members] 122 - [api_docs/cpp_api/compositetransform/members.md, CompositeTransform, Members]
146 - [api_docs/cpp_api/compositetransform/constructors.md, CompositeTransform, Constructors] 123 - [api_docs/cpp_api/compositetransform/constructors.md, CompositeTransform, Constructors]
147 -- [api_docs/cpp_api/compositetransform/statics.md, CompositeTransform, Static Functions]  
148 - [api_docs/cpp_api/compositetransform/functions.md, CompositeTransform, Functions] 124 - [api_docs/cpp_api/compositetransform/functions.md, CompositeTransform, Functions]
149 125
150 # WrapperTransform 126 # WrapperTransform
151 - [api_docs/cpp_api/wrappertransform/wrappertransform.md, C++ Plugin API, WrapperTransform] 127 - [api_docs/cpp_api/wrappertransform/wrappertransform.md, C++ Plugin API, WrapperTransform]
152 - [api_docs/cpp_api/wrappertransform/properties.md, WrapperTransform, Properties] 128 - [api_docs/cpp_api/wrappertransform/properties.md, WrapperTransform, Properties]
153 -- [api_docs/cpp_api/wrappertransform/members.md, WrapperTransform, Members]  
154 - [api_docs/cpp_api/wrappertransform/constructors.md, WrapperTransform, Constructors] 129 - [api_docs/cpp_api/wrappertransform/constructors.md, WrapperTransform, Constructors]
155 -- [api_docs/cpp_api/wrappertransform/statics.md, WrapperTransform, Static Functions]  
156 - [api_docs/cpp_api/wrappertransform/functions.md, WrapperTransform, Functions] 130 - [api_docs/cpp_api/wrappertransform/functions.md, WrapperTransform, Functions]
157 131
158 # Distance 132 # Distance
159 - [api_docs/cpp_api/distance/distance.md, C++ Plugin API, Distance] 133 - [api_docs/cpp_api/distance/distance.md, C++ Plugin API, Distance]
160 -- [api_docs/cpp_api/distance/members.md, Distance, Members]  
161 - [api_docs/cpp_api/distance/constructors.md, Distance, Constructors] 134 - [api_docs/cpp_api/distance/constructors.md, Distance, Constructors]
162 - [api_docs/cpp_api/distance/statics.md, Distance, Static Functions] 135 - [api_docs/cpp_api/distance/statics.md, Distance, Static Functions]
163 - [api_docs/cpp_api/distance/functions.md, Distance, Functions] 136 - [api_docs/cpp_api/distance/functions.md, Distance, Functions]
164 137
165 # UntrainableDistance 138 # UntrainableDistance
166 - [api_docs/cpp_api/untrainabledistance/untrainabledistance.md, C++ Plugin API, UntrainableDistance] 139 - [api_docs/cpp_api/untrainabledistance/untrainabledistance.md, C++ Plugin API, UntrainableDistance]
167 -- [api_docs/cpp_api/untrainabledistance/members.md, UntrainableDistance, Members]  
168 -- [api_docs/cpp_api/untrainabledistance/constructors.md, UntrainableDistance, Constructors]  
169 -- [api_docs/cpp_api/untrainabledistance/statics.md, UntrainableDistance, Static Functions]  
170 -- [api_docs/cpp_api/untrainabledistance/functions.md, UntrainableDistance, Functions]  
171 140
172 # Output 141 # Output
173 - [api_docs/cpp_api/output/output.md, C++ Plugin API, Output] 142 - [api_docs/cpp_api/output/output.md, C++ Plugin API, Output]
@@ -180,13 +149,11 @@ pages: @@ -180,13 +149,11 @@ pages:
180 # MatrixOutput 149 # MatrixOutput
181 - [api_docs/cpp_api/matrixoutput/matrixoutput.md, C++ Plugin API, MatrixOutput] 150 - [api_docs/cpp_api/matrixoutput/matrixoutput.md, C++ Plugin API, MatrixOutput]
182 - [api_docs/cpp_api/matrixoutput/members.md, MatrixOutput, Members] 151 - [api_docs/cpp_api/matrixoutput/members.md, MatrixOutput, Members]
183 -- [api_docs/cpp_api/matrixoutput/constructors.md, MatrixOutput, Constructors]  
184 - [api_docs/cpp_api/matrixoutput/statics.md, MatrixOutput, Static Functions] 152 - [api_docs/cpp_api/matrixoutput/statics.md, MatrixOutput, Static Functions]
185 - [api_docs/cpp_api/matrixoutput/functions.md, MatrixOutput, Functions] 153 - [api_docs/cpp_api/matrixoutput/functions.md, MatrixOutput, Functions]
186 154
187 # Format 155 # Format
188 - [api_docs/cpp_api/format/format.md, C++ Plugin API, Format] 156 - [api_docs/cpp_api/format/format.md, C++ Plugin API, Format]
189 -- [api_docs/cpp_api/format/members.md, Format, Members]  
190 - [api_docs/cpp_api/format/constructors.md, Format, Constructors] 157 - [api_docs/cpp_api/format/constructors.md, Format, Constructors]
191 - [api_docs/cpp_api/format/statics.md, Format, Static Functions] 158 - [api_docs/cpp_api/format/statics.md, Format, Static Functions]
192 - [api_docs/cpp_api/format/functions.md, Format, Functions] 159 - [api_docs/cpp_api/format/functions.md, Format, Functions]
@@ -194,7 +161,6 @@ pages: @@ -194,7 +161,6 @@ pages:
194 # Gallery 161 # Gallery
195 - [api_docs/cpp_api/gallery/gallery.md, C++ Plugin API, Gallery] 162 - [api_docs/cpp_api/gallery/gallery.md, C++ Plugin API, Gallery]
196 - [api_docs/cpp_api/gallery/properties.md, Gallery, Properties] 163 - [api_docs/cpp_api/gallery/properties.md, Gallery, Properties]
197 -- [api_docs/cpp_api/gallery/members.md, Gallery, Members]  
198 - [api_docs/cpp_api/gallery/constructors.md, Gallery, Constructors] 164 - [api_docs/cpp_api/gallery/constructors.md, Gallery, Constructors]
199 - [api_docs/cpp_api/gallery/statics.md, Gallery, Static Functions] 165 - [api_docs/cpp_api/gallery/statics.md, Gallery, Static Functions]
200 - [api_docs/cpp_api/gallery/functions.md, Gallery, Functions] 166 - [api_docs/cpp_api/gallery/functions.md, Gallery, Functions]
@@ -203,19 +169,16 @@ pages: @@ -203,19 +169,16 @@ pages:
203 - [api_docs/cpp_api/filegallery/filegallery.md, C++ Plugin API, FileGallery] 169 - [api_docs/cpp_api/filegallery/filegallery.md, C++ Plugin API, FileGallery]
204 - [api_docs/cpp_api/filegallery/members.md, FileGallery, Members] 170 - [api_docs/cpp_api/filegallery/members.md, FileGallery, Members]
205 - [api_docs/cpp_api/filegallery/constructors.md, FileGallery, Constructors] 171 - [api_docs/cpp_api/filegallery/constructors.md, FileGallery, Constructors]
206 -- [api_docs/cpp_api/filegallery/statics.md, FileGallery, Static Functions]  
207 - [api_docs/cpp_api/filegallery/functions.md, FileGallery, Functions] 172 - [api_docs/cpp_api/filegallery/functions.md, FileGallery, Functions]
208 173
209 # Representation 174 # Representation
210 - [api_docs/cpp_api/representation/representation.md, C++ Plugin API, Representation] 175 - [api_docs/cpp_api/representation/representation.md, C++ Plugin API, Representation]
211 -- [api_docs/cpp_api/representation/members.md, Representation, Members]  
212 - [api_docs/cpp_api/representation/constructors.md, Representation, Constructors] 176 - [api_docs/cpp_api/representation/constructors.md, Representation, Constructors]
213 - [api_docs/cpp_api/representation/statics.md, Representation, Static Functions] 177 - [api_docs/cpp_api/representation/statics.md, Representation, Static Functions]
214 - [api_docs/cpp_api/representation/functions.md, Representation, Functions] 178 - [api_docs/cpp_api/representation/functions.md, Representation, Functions]
215 179
216 # Classifier 180 # Classifier
217 - [api_docs/cpp_api/classifier/classifier.md, C++ Plugin API, Classifier] 181 - [api_docs/cpp_api/classifier/classifier.md, C++ Plugin API, Classifier]
218 -- [api_docs/cpp_api/classifier/members.md, Classifier, Members]  
219 - [api_docs/cpp_api/classifier/constructors.md, Classifier, Constructors] 182 - [api_docs/cpp_api/classifier/constructors.md, Classifier, Constructors]
220 - [api_docs/cpp_api/classifier/statics.md, Classifier, Static Functions] 183 - [api_docs/cpp_api/classifier/statics.md, Classifier, Static Functions]
221 - [api_docs/cpp_api/classifier/functions.md, Classifier, Functions] 184 - [api_docs/cpp_api/classifier/functions.md, Classifier, Functions]