Browse Source

Merge pull request #403 from pelias/fix_docs_generation

Make doc generation a bit easier
pull/408/head
Julian Simioni 9 years ago
parent
commit
1d4226e2dc
  1. 9
      bin/generate-docs
  2. 2
      package.json
  3. 2
      test/ciao/search/layers_invalid.coffee
  4. 2
      test/ciao/search/layers_mix_invalid_valid.coffee
  5. 2
      test/ciao/search/sources_invalid.coffee

9
bin/generate-docs

@ -0,0 +1,9 @@
#!/bin/bash -ex
rm -r docs || true
curl -s http://localhost:3100/v1 > /dev/null || die "Pelias server does not appear to be running \
on http://localhost:3100, run npm start in another window before generating docs."
cd test/ciao
node ../../node_modules/ciao/bin/ciao -c ../ciao.json . -d ../../docs

2
package.json

@ -13,7 +13,7 @@
"ciao": "node node_modules/ciao/bin/ciao -c test/ciao.json test/ciao", "ciao": "node node_modules/ciao/bin/ciao -c test/ciao.json test/ciao",
"coverage": "node_modules/.bin/istanbul cover test/unit/run.js", "coverage": "node_modules/.bin/istanbul cover test/unit/run.js",
"audit": "npm shrinkwrap; node node_modules/nsp/bin/nspCLI.js audit-shrinkwrap; rm npm-shrinkwrap.json;", "audit": "npm shrinkwrap; node node_modules/nsp/bin/nspCLI.js audit-shrinkwrap; rm npm-shrinkwrap.json;",
"docs": "rm -r docs; cd test/ciao; node ../../node_modules/ciao/bin/ciao -c ../ciao.json . -d ../../docs" "docs": "./bin/generate-docs"
}, },
"repository": { "repository": {
"type": "git", "type": "git",

2
test/ciao/search/layers_invalid.coffee

@ -32,5 +32,3 @@ should.not.exist json.geocoding.warnings
#? inputs #? inputs
json.geocoding.query['text'].should.eql 'a' json.geocoding.query['text'].should.eql 'a'
json.geocoding.query['size'].should.eql 10 json.geocoding.query['size'].should.eql 10
should.not.exist json.geocoding.query['types']
should.not.exist json.geocoding.query['type']

2
test/ciao/search/layers_mix_invalid_valid.coffee

@ -32,5 +32,3 @@ should.not.exist json.geocoding.warnings
#? inputs #? inputs
json.geocoding.query['text'].should.eql 'a' json.geocoding.query['text'].should.eql 'a'
json.geocoding.query['size'].should.eql 10 json.geocoding.query['size'].should.eql 10
should.not.exist json.geocoding.query['types']
should.not.exist json.geocoding.query['type']

2
test/ciao/search/sources_invalid.coffee

@ -32,5 +32,3 @@ should.not.exist json.geocoding.warnings
#? inputs #? inputs
json.geocoding.query['text'].should.eql 'a' json.geocoding.query['text'].should.eql 'a'
json.geocoding.query['size'].should.eql 10 json.geocoding.query['size'].should.eql 10
should.not.exist json.geocoding.query['types']
should.not.exist json.geocoding.query['type']

Loading…
Cancel
Save