Skip to content

Commit

Permalink
[js] Stop distributing api docs with the npm package.
Browse files Browse the repository at this point in the history
Docs still available online
  • Loading branch information
jleyba committed Jan 16, 2016
1 parent 2679215 commit af60554
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
5 changes: 3 additions & 2 deletions javascript/node/deploy.js
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,9 @@ function generateDocs(outputDir, callback) {
return sourceFiles.indexOf(file) == -1;
});

var output = outputDir + '-docs';
var config = {
'output': path.join(outputDir, 'docs'),
'output': output,
'closureLibraryDir': path.join(outputDir, 'lib', 'goog'),
'customPages': [
{'name': 'Changes', 'path': path.join(outputDir, 'CHANGES.md')}
Expand All @@ -409,7 +410,7 @@ function generateDocs(outputDir, callback) {
'typeFilters': ['goog']
};

var configFile = outputDir + '-docs.json';
var configFile = output + '.json';
fs.writeFileSync(configFile, JSON.stringify(config), 'utf8');

var command = [
Expand Down
2 changes: 2 additions & 0 deletions javascript/node/selenium-webdriver/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
* Changed some `io` operations to use native promises.
* Changed `webdriver.CommandExecutor#execute()` and `HttpClient` to return
promises instead of using callback passing.
* API documentation is no longer distributed with the npm package, but remains
available at <http://seleniumhq.github.io/selenium/docs/api/javascript/>
* Rewrote the `error` module to export an Error subtype for each type of error
defined in the [W3C WebDriver spec](https://w3c.github.io/webdriver/webdriver-spec.html#handling-errors).
For the export types, the `code` property is now the string code used by
Expand Down
4 changes: 2 additions & 2 deletions javascript/node/selenium-webdriver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ script provided with `selenium-webdriver`.

## Documentation

API documentation is included in the `docs` directory and is also available
online from the [Selenium project][api]. Addition resources include
API documentation is available online from the [Selenium project][api].
Addition resources include

- the #selenium channel on freenode IRC
- the [selenium-users@googlegroups.com][users] list
Expand Down

0 comments on commit af60554

Please sign in to comment.