Skip to content

Commit

Permalink
Document the version and sha constants.
Browse files Browse the repository at this point in the history
Update a few additional things related to documentation.
  • Loading branch information
manthey committed Jul 2, 2018
1 parent e1b835b commit ca4878c
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 9 deletions.
4 changes: 0 additions & 4 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
src/vgl/**
src/version.js
src/sha.js
src/util/wigglemaps.js
src/util/distanceGrid.js
dist/**
testing/**
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import json
import os
import shutil
import re
import sys
from glob import glob
# from subprocess import check_output

Expand Down Expand Up @@ -73,7 +73,7 @@
# built documents.
#
# The short X.Y version.
version = '0.16.0'
version = json.load(open(os.path.join(toppath, 'package.json')))['version']
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
2 changes: 1 addition & 1 deletion docs/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ list of libraries used by GeoJS.
+---------------------------+------------+---------------------------+
| `earcut`_ | 2.1 | GL polygon feature |
+---------------------------+------------+---------------------------+
| `jQuery`_ | 2.2 | Core |
| `jQuery`_ | 3.3 | Core |
+---------------------------+------------+---------------------------+

.. table:: External GeoJS dependencies
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// License headers that will be preserved in distributed bundles.
/**
* GeoJS
* @copyright 2013-2017, Kitware, Inc.
* @copyright 2013-2018, Kitware, Inc.
* @license Apache-2.0
*
* Bundled with the following libraries:
Expand Down
9 changes: 9 additions & 0 deletions src/sha.js
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
/* global GEO_SHA */

/**
* The current geojs git SHA.
*
* @alias geo.sha
* @constant
* @type {string}
*/
module.exports = GEO_SHA;
9 changes: 9 additions & 0 deletions src/version.js
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
/* global GEO_VERSION */

/**
* The current geojs version.
*
* @alias geo.version
* @constant
* @type {string}
*/
module.exports = GEO_VERSION;

0 comments on commit ca4878c

Please sign in to comment.