Commit graph

7 commits

Author SHA1 Message Date
Timo Tijhof 1082249691 build: Move pre/post 'doc' task into package.json
Standard entry point.

Change-Id: Ic6cdc9ac1b266a64dcb1522ac36132c5ef844d3c
2015-04-06 17:18:29 +01:00
Timo Tijhof 5813d53271 Update JSDuck config to standard jsduck.json
Also
* This way we don't need to pass the --config=jsduck.config.json
  parameter but can run plain 'jsduck' in Jenkins. Allowing it
  to use the standard job template for testing.

* Move processes=0 to jsduck.json.
  Workaround for https://github.com/senchalabs/jsduck/issues/525

* Use standard ' - Documentation' suffix, which makes the first
  part of the title render in bold (similar to how we do in OOjs
  and OOjs UI already).

Change-Id: I6c9c7a1f29df0a72dc8cd0d37a83aaef23068062
2015-03-05 23:51:53 +01:00
Timo Tijhof d6478ec548 generateDocs.sh: Simplify
* Make more like mediawiki-core's mwjsduckgen.
  - Use bash set -e to have the script abort early when any
    part of it fails (especially the jsduck command).
  - Since it will abort early, we don't need the 'test' for the
    symlink. If jsduck succeeded, it will have re-created the
    docs directory and thus not have the symlink yet.
  - Don't "cd" into anything from the script, simply use absolute
    paths instead. Both jsduck and ln support this.

Change-Id: I03c02d590e0f696c78da87ff638bb407e48a7cd7
2014-05-03 21:16:24 +02:00
Timo Tijhof f42cf1f924 docs: Remove JSDuck 4 support
And migrate deprecated "-no_doc" option.

Change-Id: I2e1e89408328c614a89f6c4e408df90d1e346d76
2014-04-29 20:20:49 +02:00
Timo Tijhof 1944b0c6f0 jsduck: Fix script loading issues with eg-iframe in production
It works locally because it can just nagivate to ../lib/ve.

In production however we need docs/ to be standalone so that we
can publish it without needing a subdirectory at:
https://docs.wikimedia.org/VisualEditor/master/.

For local usage this will be a symlink that still points to
the sibling directory (but using a symlink instead of a ../ path).
In production we can then instruct jenkins to replace that symlink
with an actual copy of lib/. As long as the generated path
references in the HTML remain the same.

Follows-up 88c4888872, which broke the publication of the docs in
Jenkins as it changed references from modules/ to ../modules/ for
the eg-iframe. This works locally, but broke in Jenkins as it was relying
on the copying of modules/ to docs/modules/ being enough to make it work).

Change-Id: I10eaa5424d172932b29774a0f03d511d555fd121
2014-01-16 20:41:20 +00:00
Roan Kattouw 88c4888872 Replace makeStaticLoader with a grunt task
'grunt build' builds modules/ve/test/index.php, demos/ve/index.php
and .docs/eg-iframe.html from the associated *.template files.

Got rid of the JS-based SVG/PNG switching logic. Instead, we now
just use SVG unconditionally. We'd already dropped browser support
for browsers that don't support SVG anyway.

Change-Id: Iba2e68f17904687cb13e793a410e095f28f1b13c
2013-12-17 22:03:01 +01:00
Timo Tijhof c42840541e Add bin/ directory with updateStaticLoaders and generateDocs
Adding a symlink in .docs/generate.sh because of Jenkins and
possibly other uses.

Change-Id: Ieb56852d0d0b978fbc1cbb873204d9e457cf969c
2013-10-22 23:51:51 +02:00