-
Notifications
You must be signed in to change notification settings - Fork 5
Legacy api docs
The documentation parser for Dojo was redeveloped after version 1.7 and the previous API viewer relied on the legacy documentation parser's output. The PHP API viewer also contained a spider option; it's function was to create static API documentation for offline viewing e.g. no app server.
This application does not intend to support generating static API docs for legacy i.e. pre 1.8, versions of Dojo. It will however, support viewing legacy versions of API documentation.
There is therefore a caveat if you need to provide API docs for legacy versions, you must generate them with the legacy API viewer and manually copy them to dapi's staticoutput directory.
This viewer (the node.js viewer) is configurable such that context paths can be configured according to your requirements, however if you need to use legacy API docs you will have to generate them first (using the PHP viewer) with the correct context path.
There is an alternative if you want to view legacy documentation for only the DOJO API's i.e. not including your own legacy custom packages:
You can clone whatever parts of this repository https://github.com/wkeese/dojo-api-data you need, this is the exported static HTML from dapi for the base DTK API's; however these docs have been generated with the context path /api which may or may not meet your needs.
Including legacy docs using the app server requires that you copy the static legacy HTML docs to
/public
/api/
e.g. /public/api/1.7
Also (as per the requirements of https://github.com/lbod/dapi/wiki/Installation#copy-the-api-data-sources) you need to copy the tree.json data source.
It's not elegant having to deal with static and application served code together, it could/should be improved.
It's not a requirement per se of spider.js but to run all the documentation output from it including legacy docs (served via an HTTP server) and make sure that permalinks are handled correctly, you need to use some rewrite rules.
An example (of Apache config) is at https://github.com/wkeese/dojo-api-data/blob/master/.htaccess