Skip to content

Commit

Permalink
Merge branch 'master' into minor-map-improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
manthey authored Jun 16, 2017
2 parents 08abab9 + a485da6 commit 4920faa
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 10 deletions.
15 changes: 15 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
comment: false
coverage:
status:
# We have some variation in tests due to variations in the test runs. We
# want to ignore these changes, but not let code coverage slip too much.
project:
default:
threshold: 0.1
# This applies to the changed code. We allow it to be much less covered
# than the main code, since we use the project threshold for that.
patch:
default:
threshold: 25
only_pulls: true

4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_static_path = []
# html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ If you have any questions or comments, feel free to join us on our
developers
provisioning
testingutils
API Reference <http://opengeoscience.github.io/geojs/apidocs/geo.html>

Indices and tables
==================
Expand Down
1 change: 0 additions & 1 deletion docs/testingutils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ Testing infrastructure
:maxdepth: 2

baseline_images
upload_test_cases
5 changes: 0 additions & 5 deletions docs/upload_test_cases.rst

This file was deleted.

6 changes: 3 additions & 3 deletions docs/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ class definition inside GeoJS.
Class overview
---------------

The latest version of the full API documentation is at
`http://opengeoscience.github.io/geojs/apidocs/geo.html <http://opengeoscience.github.io/geojs/apidocs/geo.html>`_.

GeoJS is made up of the following core classes. Click on the link to go to the
documentation for each of the classes.

Expand Down Expand Up @@ -215,9 +218,6 @@ documentation for each of the classes.
`geo.jsonReader <http://opengeoscience.github.io/geojs/apidocs/geo.jsonReader.html>`_,
which is an extendable geojson reader.

The API documentation is in the process of being updated. You can always find the latest version
at `http://opengeoscience.github.io/geojs/apidocs/geo.html <http://opengeoscience.github.io/geojs/apidocs/geo.html>`_.

Coordinate systems
------------------

Expand Down
1 change: 1 addition & 0 deletions jsdoc.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"template": "node_modules/jaguarjs-jsdoc"
},
"plugins": [
"jsdoc/plugins/events",
"node_modules/jsdoc-autoprivate/autoprivate.js",
"plugins/markdown"
],
Expand Down
34 changes: 34 additions & 0 deletions jsdoc/plugins/events.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
function fixEventName(event) {
return event.replace('event:', '');
}

/**
* Define a jsdoc plugin to replace the `longname` of
* event doclets from `geo.event.event:pan` to `geo.event.pan`.
*/
exports.handlers = {
/**
* Replace the `longname` of all event doclets.
*/
newDoclet: function (e) {
var doclet = e.doclet;
if (doclet.kind === 'event') {
doclet.longname = fixEventName(doclet.longname);
}
},

/**
* Replace the displayed name of events to match the changed
* doclet names.
*/
parseComplete: function (e) {
e.doclets.forEach(function (doclet) {
if (doclet.fires) {
doclet.fires = doclet.fires.map(fixEventName);
}
if (doclet.listens) {
doclet.listens = doclet.listens.map(fixEventName);
}
});
}
};

0 comments on commit 4920faa

Please sign in to comment.