Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GEOT-6494] MBStyle extension #2743

Merged
merged 11 commits into from
Feb 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions docs/LICENSE.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
</dependencies>
<executions>
<execution>
<id>compile</id>
<id>sphinx</id>
<phase>compile</phase>
<configuration>
<tasks>
Expand Down
30 changes: 30 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -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.
99 changes: 0 additions & 99 deletions docs/readme.txt

This file was deleted.

6 changes: 3 additions & 3 deletions docs/user/build/maven/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^
Expand Down
8 changes: 5 additions & 3 deletions docs/user/extension/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
21 changes: 21 additions & 0 deletions docs/user/extension/mbstyle/index.rst
Original file line number Diff line number Diff line change
@@ -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)

Loading