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

Document the version and sha constants. #849

Merged
merged 2 commits into from
Jul 12, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
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']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

# 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;