[GEOT-6494] MBStyle extension (#2743)

* cleaning up javadoc warnings Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * [GEOT-6494] updated test coverage instructions Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * [GEOT-6494] addressing javadoc warnings Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * Formatting clean up Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * javadoc warnings Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * initial move of mbstyle extension and documentation Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * fix build Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * break spec into pages Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * Clean up license references in documentation Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * revise based on feedback Signed-off-by: Jody Garnett <jody.garnett@gmail.com> * remove toctree caption Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
geotools · Feb 13, 2020 · b709df9 · b709df9
1 parent fbe84e3
commit b709df9
Show file tree

Hide file tree

Showing 269 changed files with 7,802 additions and 8,019 deletions.
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -244,7 +244,7 @@
         </dependencies>
         <executions>
           <execution>
-            <id>compile</id>
+            <id>sphinx</id>
             <phase>compile</phase>
             <configuration>
               <tasks>

diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1,30 @@
+# GeoTools Documentation
+
+GeoTools documentation is provided using a [Attribution 3.0 Unported](LICENSE.md) license.
+
+Code examples are [explicitly placed into the public domain](LICENSE.txt), to facilitate the easy cut-and-paste of example code.
+
+## Sphinx
+
+GeoTools makes use of the python sphinx documentation system:
+
+```
+   pip install sphinx
+```
+
+The maven compile stage is used to generate documentation:
+
+```   
+   mvn compile
+   mvn compile -Puser
+   mvn compile -Pdeveloper
+```
+
+You may also quickly test by calling the ant `build.xml` directly::
+
+```   
+   ant user
+   ant developer
+```
+
+Please see the user guide build instructions for more detail.
diff --git a/docs/readme.txt b/docs/readme.txt
diff --git a/docs/user/build/maven/testing.rst b/docs/user/build/maven/testing.rst
@@ -30,11 +30,11 @@ If you are having problems with logging output levels be sure to read the loggin
 Test Coverage
 ^^^^^^^^^^^^^
 
-You can use maven to measure test coverage::
+Maven jacoco report is configured and available using::
 
-   mvn -o clean cobertura:cobertura
+   mvn test site
 
-The resulting report is located in :file:`target/site/cobertura/index.html``.
+The resulting report is located in :file:`target/site/jacoco/index.html``.
 
 Online Testing
 ^^^^^^^^^^^^^^

diff --git a/docs/user/extension/index.rst b/docs/user/extension/index.rst
@@ -5,19 +5,21 @@ Extensions
 Extensions build additional functionality on top of the core services of the GeoTools library.
 
 .. toctree::
-
+   :maxdepth: 2
+
    app-schema
    brewer/index
    complex
    graph/index
    grid
+   mbstyle/index
    ogc/index
-   wms/index
    tile-client/index
+   transform/transform
+   wms/index
    wmts/index
    validation
    xsd/index
-   transform/transform
    ysld
 
 Extensions build on top of the core concepts provided by the GeoTools library. This allows the project to take on more general topics than just being a simple geospatial library.
diff --git a/docs/user/extension/mbstyle/index.rst b/docs/user/extension/mbstyle/index.rst
@@ -0,0 +1,21 @@
+Mapbox Styles Module
+--------------------
+
+The ``gt-mbstyle`` module is an unsupported module that provides a parser/encoder to convert between Mapbox Styles and GeoTools style objects. These docs are under active development, along with the module itself.
+
+.. toctree::
+   :maxdepth: 1
+
+   overview
+
+Specification:
+
+.. toctree::
+   :maxdepth: 2
+
+   spec/index
+
+References:
+
+* `MapBox Style Specification <https://www.mapbox.com/mapbox-gl-js/style-spec/>`__ (Mapbox GL JS)
+