From 8d42271f3a3e6389c6393978364c0f7542a8fd33 Mon Sep 17 00:00:00 2001 From: Jordan Cheney Date: Fri, 1 May 2015 16:14:59 -0400 Subject: [PATCH] Update website structure to reflect removed files also add docs script and instructions --- docs/DOCS.md | 13 +++++++++++++ docs/build_docs.sh | 6 ++++++ docs/mkdocs.yml | 37 ------------------------------------- 3 files changed, 19 insertions(+), 37 deletions(-) create mode 100644 docs/DOCS.md create mode 100644 docs/build_docs.sh diff --git a/docs/DOCS.md b/docs/DOCS.md new file mode 100644 index 0000000..a52a946 --- /dev/null +++ b/docs/DOCS.md @@ -0,0 +1,13 @@ +# OpenBR Documentation Guide + +This is a quick guide for generating the OpenBR documentation on your local machine. The documentation is available online at www.openbiometrics.org. + +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- + + $ pip install mkdocs + +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 + + $ mkdocs serve + +from openbr/docs and then go to http://127.0.0.1:8000 in your internet browser of choice to view the docs locally. diff --git a/docs/build_docs.sh b/docs/build_docs.sh new file mode 100644 index 0000000..dbbde0f --- /dev/null +++ b/docs/build_docs.sh @@ -0,0 +1,6 @@ +# Build the OpenBR documentation as static html +# +# NOTE: This requires mkdocs to be installed. Please see DOCS.md file for +# instructions + +mkdocs build diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ec57da9..7e3f4e5 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -20,7 +20,6 @@ pages: - [install.md, Install] - [tutorials.md, Tutorials] - [contribute.md, Contribute] -- [papers.md, Publications] # C API - [api_docs/c_api.md, API Docs, C API] @@ -41,7 +40,6 @@ pages: # FileList - [api_docs/cpp_api/filelist/filelist.md, C++ Plugin API, FileList] -- [api_docs/cpp_api/filelist/members.md, FileList, Members] - [api_docs/cpp_api/filelist/constructors.md, FileList, Constructors] - [api_docs/cpp_api/filelist/statics.md, FileList, Static Functions] - [api_docs/cpp_api/filelist/functions.md, FileList, Functions] @@ -55,7 +53,6 @@ pages: # TemplateList - [api_docs/cpp_api/templatelist/templatelist.md, C++ Plugin API, TemplateList] -- [api_docs/cpp_api/templatelist/members.md, TemplateList, Members] - [api_docs/cpp_api/templatelist/constructors.md, TemplateList, Constructors] - [api_docs/cpp_api/templatelist/statics.md, TemplateList, Static Functions] - [api_docs/cpp_api/templatelist/functions.md, TemplateList, Functions] @@ -66,12 +63,10 @@ pages: - [api_docs/cpp_api/factory/constructors.md, Factory, Constructors] - [api_docs/cpp_api/factory/macros.md, Factory, Macros] - [api_docs/cpp_api/factory/statics.md, Factory, Static Functions] -- [api_docs/cpp_api/factory/functions.md, Factory, Functions] # Object - [api_docs/cpp_api/object/object.md, C++ Plugin API, Object] - [api_docs/cpp_api/object/members.md, Object, Members] -- [api_docs/cpp_api/object/constructors.md, Object, Constructors] - [api_docs/cpp_api/object/macros.md, Object, Macros] - [api_docs/cpp_api/object/statics.md, Object, Static Functions] - [api_docs/cpp_api/object/functions.md, Object, Functions] @@ -79,15 +74,12 @@ pages: # Context - [api_docs/cpp_api/context/context.md, C++ Plugin API, Context] - [api_docs/cpp_api/context/members.md, Context, Members] -- [api_docs/cpp_api/context/constructors.md, Context, Constructors] - [api_docs/cpp_api/context/statics.md, Context, Static Functions] - [api_docs/cpp_api/context/functions.md, Context, Functions] # Initializer - [api_docs/cpp_api/initializer/initializer.md, C++ Plugin API, Initializer] -- [api_docs/cpp_api/initializer/members.md, Initializer, Members] - [api_docs/cpp_api/initializer/constructors.md, Initializer, Constructors] -- [api_docs/cpp_api/initializer/statics.md, Initializer, Static Functions] - [api_docs/cpp_api/initializer/functions.md, Initializer, Functions] # Transform @@ -99,44 +91,29 @@ pages: # UntrainableTransform - [api_docs/cpp_api/untrainabletransform/untrainabletransform.md, C++ Plugin API, UntrainableTransform] -- [api_docs/cpp_api/untrainabletransform/members.md, UntrainableTransform, Members] - [api_docs/cpp_api/untrainabletransform/constructors.md, UntrainableTransform, Constructors] -- [api_docs/cpp_api/untrainabletransform/statics.md, UntrainableTransform, Static Functions] -- [api_docs/cpp_api/untrainabletransform/functions.md, UntrainableTransform, Functions] # MetaTransform - [api_docs/cpp_api/metatransform/metatransform.md, C++ Plugin API, MetaTransform] -- [api_docs/cpp_api/metatransform/members.md, MetaTransform, Members] - [api_docs/cpp_api/metatransform/constructors.md, MetaTransform, Constructors] -- [api_docs/cpp_api/metatransform/statics.md, MetaTransform, Static Functions] -- [api_docs/cpp_api/metatransform/functions.md, MetaTransform, Functions] # UntrainableMetaTransform - [api_docs/cpp_api/untrainablemetatransform/untrainablemetatransform.md, C++ Plugin API, UntrainableMetaTransform] -- [api_docs/cpp_api/untrainablemetatransform/members.md, UntrainableMetaTransform, Members] - [api_docs/cpp_api/untrainablemetatransform/constructors.md, UntrainableMetaTransform, Constructors] -- [api_docs/cpp_api/untrainablemetatransform/statics.md, UntrainableMetaTransform, Static Functions] -- [api_docs/cpp_api/untrainablemetatransform/functions.md, UntrainableMetaTransform, Functions] # MetadataTransform - [api_docs/cpp_api/metadatatransform/metadatatransform.md, C++ Plugin API, MetadataTransform] -- [api_docs/cpp_api/metadatatransform/members.md, MetadataTransform, Members] - [api_docs/cpp_api/metadatatransform/constructors.md, MetadataTransform, Constructors] -- [api_docs/cpp_api/metadatatransform/statics.md, MetadataTransform, Static Functions] - [api_docs/cpp_api/metadatatransform/functions.md, MetadataTransform, Functions] # UntrainableMetadataTransform - [api_docs/cpp_api/untrainablemetadatatransform/untrainablemetadatatransform.md, C++ Plugin API, UntrainableMetadataTransform] -- [api_docs/cpp_api/untrainablemetadatatransform/members.md, UntrainableMetadataTransform, Members] - [api_docs/cpp_api/untrainablemetadatatransform/constructors.md, UntrainableMetadataTransform, Constructors] -- [api_docs/cpp_api/untrainablemetadatatransform/statics.md, UntrainableMetadataTransform, Static Functions] -- [api_docs/cpp_api/untrainablemetadatatransform/functions.md, UntrainableMetadataTransform, Functions] # TimeVaryingTransform - [api_docs/cpp_api/timevaryingtransform/timevaryingtransform.md, C++ Plugin API, TimeVaryingTransform] - [api_docs/cpp_api/timevaryingtransform/members.md, TimeVaryingTransform, Members] - [api_docs/cpp_api/timevaryingtransform/constructors.md, TimeVaryingTransform, Constructors] -- [api_docs/cpp_api/timevaryingtransform/statics.md, TimeVaryingTransform, Static Functions] - [api_docs/cpp_api/timevaryingtransform/functions.md, TimeVaryingTransform, Functions] # CompositeTransform @@ -144,30 +121,22 @@ pages: - [api_docs/cpp_api/compositetransform/properties.md, CompositeTransform, Properties] - [api_docs/cpp_api/compositetransform/members.md, CompositeTransform, Members] - [api_docs/cpp_api/compositetransform/constructors.md, CompositeTransform, Constructors] -- [api_docs/cpp_api/compositetransform/statics.md, CompositeTransform, Static Functions] - [api_docs/cpp_api/compositetransform/functions.md, CompositeTransform, Functions] # WrapperTransform - [api_docs/cpp_api/wrappertransform/wrappertransform.md, C++ Plugin API, WrapperTransform] - [api_docs/cpp_api/wrappertransform/properties.md, WrapperTransform, Properties] -- [api_docs/cpp_api/wrappertransform/members.md, WrapperTransform, Members] - [api_docs/cpp_api/wrappertransform/constructors.md, WrapperTransform, Constructors] -- [api_docs/cpp_api/wrappertransform/statics.md, WrapperTransform, Static Functions] - [api_docs/cpp_api/wrappertransform/functions.md, WrapperTransform, Functions] # Distance - [api_docs/cpp_api/distance/distance.md, C++ Plugin API, Distance] -- [api_docs/cpp_api/distance/members.md, Distance, Members] - [api_docs/cpp_api/distance/constructors.md, Distance, Constructors] - [api_docs/cpp_api/distance/statics.md, Distance, Static Functions] - [api_docs/cpp_api/distance/functions.md, Distance, Functions] # UntrainableDistance - [api_docs/cpp_api/untrainabledistance/untrainabledistance.md, C++ Plugin API, UntrainableDistance] -- [api_docs/cpp_api/untrainabledistance/members.md, UntrainableDistance, Members] -- [api_docs/cpp_api/untrainabledistance/constructors.md, UntrainableDistance, Constructors] -- [api_docs/cpp_api/untrainabledistance/statics.md, UntrainableDistance, Static Functions] -- [api_docs/cpp_api/untrainabledistance/functions.md, UntrainableDistance, Functions] # Output - [api_docs/cpp_api/output/output.md, C++ Plugin API, Output] @@ -180,13 +149,11 @@ pages: # MatrixOutput - [api_docs/cpp_api/matrixoutput/matrixoutput.md, C++ Plugin API, MatrixOutput] - [api_docs/cpp_api/matrixoutput/members.md, MatrixOutput, Members] -- [api_docs/cpp_api/matrixoutput/constructors.md, MatrixOutput, Constructors] - [api_docs/cpp_api/matrixoutput/statics.md, MatrixOutput, Static Functions] - [api_docs/cpp_api/matrixoutput/functions.md, MatrixOutput, Functions] # Format - [api_docs/cpp_api/format/format.md, C++ Plugin API, Format] -- [api_docs/cpp_api/format/members.md, Format, Members] - [api_docs/cpp_api/format/constructors.md, Format, Constructors] - [api_docs/cpp_api/format/statics.md, Format, Static Functions] - [api_docs/cpp_api/format/functions.md, Format, Functions] @@ -194,7 +161,6 @@ pages: # Gallery - [api_docs/cpp_api/gallery/gallery.md, C++ Plugin API, Gallery] - [api_docs/cpp_api/gallery/properties.md, Gallery, Properties] -- [api_docs/cpp_api/gallery/members.md, Gallery, Members] - [api_docs/cpp_api/gallery/constructors.md, Gallery, Constructors] - [api_docs/cpp_api/gallery/statics.md, Gallery, Static Functions] - [api_docs/cpp_api/gallery/functions.md, Gallery, Functions] @@ -203,19 +169,16 @@ pages: - [api_docs/cpp_api/filegallery/filegallery.md, C++ Plugin API, FileGallery] - [api_docs/cpp_api/filegallery/members.md, FileGallery, Members] - [api_docs/cpp_api/filegallery/constructors.md, FileGallery, Constructors] -- [api_docs/cpp_api/filegallery/statics.md, FileGallery, Static Functions] - [api_docs/cpp_api/filegallery/functions.md, FileGallery, Functions] # Representation - [api_docs/cpp_api/representation/representation.md, C++ Plugin API, Representation] -- [api_docs/cpp_api/representation/members.md, Representation, Members] - [api_docs/cpp_api/representation/constructors.md, Representation, Constructors] - [api_docs/cpp_api/representation/statics.md, Representation, Static Functions] - [api_docs/cpp_api/representation/functions.md, Representation, Functions] # Classifier - [api_docs/cpp_api/classifier/classifier.md, C++ Plugin API, Classifier] -- [api_docs/cpp_api/classifier/members.md, Classifier, Members] - [api_docs/cpp_api/classifier/constructors.md, Classifier, Constructors] - [api_docs/cpp_api/classifier/statics.md, Classifier, Static Functions] - [api_docs/cpp_api/classifier/functions.md, Classifier, Functions] -- libgit2 0.21.4