Commit graph

341 commits

Author SHA1 Message Date
Di Peng
bee78a8492 feat(docs): add a changelog link to the footer 2011-07-26 14:21:13 -07:00
Vojta Jina
00ea08e0ab doc(tutorial): fix navigation widget to work without jQuery
jqLite doesn't support class selectors, can find only by tag name...
2011-07-26 14:20:24 -07:00
Di Peng
8fa066190a refactor(gen-docs): use q, qq, q-fs (node modules) to write gen-docs
- re-write gendocs.js, reader.js and writer.js
- all calls are asynchronous
2011-07-20 17:33:18 -07:00
Di Peng
e90b741c94 feat(gen-docs): enable caching the whole site
Generate a manifest file automatically by reading the directories.
2011-07-20 17:09:40 -07:00
Igor Minar
ad3b8d7bcf chore(docs/.htaccess): bundle .htaccess with docs 2011-07-19 16:58:40 -07:00
Di Peng
f9b4c9da64 refactor(docs): run e2e tests with and without jquery
- e2e tests will run index.html (without jquery) and with
index-jq.html(with jquery).
- many small changes to make e2e tests work withough JQuery as we
discover problems that were previously hidden by using real JQuery.
2011-07-17 22:19:08 -07:00
Igor Minar
a8f4d87be5 doc(css): add '#content-list .level-4' css 2011-07-16 01:12:29 -07:00
Igor Minar
57ea8156a1 doc(ngdoc): add 'this' and 'returns' section for methods 2011-07-16 01:12:29 -07:00
Igor Minar
6289d18e61 doc(ngdoc): fix usage format for functions bolted onto services 2011-07-16 01:12:29 -07:00
Igor Minar
76a500179d docs:template: rename <angular/> to AngularJS 2011-07-08 08:24:09 -07:00
Igor Minar
7b32c71386 docs:css: remove bullet points from tutorial sidebar 2011-07-08 08:24:09 -07:00
Igor Minar
28e84ca167 docs:css: fix indentation for pre element 2011-07-08 08:24:09 -07:00
Igor Minar
952225f020 doc:dependencies: add /api/ prefix to dependency links 2011-07-02 10:37:04 -07:00
Igor Minar
1e8448b9e5 fix:docs: properly distinguish between being offline and 404 2011-06-30 00:49:44 -07:00
Igor Minar
ce4f27aa7b fix:docs: css lint fixes 2011-06-27 15:05:38 -07:00
Di Peng
8e6e09a4bc fix:docs: Fix sitemap generator to use doc.id instead of doc.name
doc.id should be used instead of doc.name, otherwise links are wrongly
generated
2011-06-25 08:00:43 -07:00
Vojta Jina
f370be85cb Fix small typo in docs widget (tutorial instructions) 2011-06-10 18:30:55 +02:00
Misko Hevery
f9f95879f0 Added support for properties in documentation 2011-06-08 15:21:33 -07:00
Misko Hevery
8cad231bd2 Refactor injector to have invoke method for speed reasons 2011-06-08 15:21:31 -07:00
Vojta Jina
e670a812fa Remove removing old comments from gdocs
There were two places where we were removing old comments from google docs:

* gdocs.js fetching script
* docs/src/reader.js
2011-06-07 14:56:56 -07:00
Igor Minar
25b3438fd7 add appcache for docs site - caches only css/js/img resources 2011-06-07 14:56:01 -07:00
Igor Minar
f21b9214e6 remove $script loader because incompatibilities with e2e runner 2011-06-07 10:39:57 -07:00
Igor Minar
80ea329d5f fix css for api reference 2011-06-07 07:44:59 -07:00
Igor Minar
6e0ff5fa96 fixing the dev guide ordering 2011-06-07 07:44:49 -07:00
Vojta Jina
4cdce2d30b Docs: Error 404 page with simple suggestion for new links 2011-06-06 23:10:30 -07:00
Igor Minar
48e69ed4d1 moving the angular.mock docs down in the api list 2011-06-06 23:10:30 -07:00
Igor Minar
c35b0a7907 yet another docs batch 2011-06-06 23:10:30 -07:00
Igor Minar
805bb5bb6e fixing broken docs links 2011-06-06 23:10:30 -07:00
Igor Minar
dd44e00ddd docs css fix for content-list indentation 2011-06-06 23:10:29 -07:00
Igor Minar
759e6ea8ed docs css fixes 2011-06-06 23:10:28 -07:00
Igor Minar
af710c3ac1 fix wrapping api links into code element 2011-06-06 23:10:27 -07:00
Igor Minar
e89ef35d05 make *.angularjs.org analytics work on subdomains 2011-06-06 23:10:27 -07:00
Igor Minar
c6dbdde6dc fix hashpath prefix for docs/sitemap/etc 2011-06-06 23:10:27 -07:00
Igor Minar
f8417b48be docs app css/js/html rewrite 2011-06-06 22:52:02 -07:00
Igor Minar
5533e48dea work in progress 2011-06-06 22:52:02 -07:00
Vojta Jina
16d0354f93 Load GA script using $script loader 2011-06-06 22:52:02 -07:00
Vojta Jina
350ee31107 Google Analytics - basic page tracking for docs 2011-06-06 22:52:02 -07:00
Vojta Jina
2da07127e4 Add doc:tutorial-instructions widget 2011-06-06 22:52:01 -07:00
Vojta Jina
2380943106 Allow "section/" links pointing to "section/index" 2011-06-06 22:52:01 -07:00
Vojta Jina
43b2cd45f0 Allow relative links in docs
So you can use links without section when they link within the section.
2011-06-06 22:52:01 -07:00
Vojta Jina
e389911a35 Change warning to log place first and then link 2011-06-06 22:52:00 -07:00
Vojta Jina
3616716615 Indent the API reference list 2011-06-06 22:52:00 -07:00
Vojta Jina
76df0db598 Fixed docs search input with
And couple of missing semi-colons...
2011-06-06 22:52:00 -07:00
Vojta Jina
7fe46e8d7e Bit of refactoring 2011-06-06 22:51:59 -07:00
Vojta Jina
864da8b553 Couple of todos 2011-06-06 22:51:59 -07:00
Vojta Jina
8cb84eac68 Log warning for every non existing link instead of throwing exception
Guess we don't want to stop doc generating process because of non-existing link, so just log warning and continue...
2011-06-06 22:51:59 -07:00
Vojta Jina
2e0e732cad Check whether links do exist and throw exception 2011-06-06 22:51:59 -07:00
Igor Minar
14407921c7 reorder docs main menu items 2011-06-06 22:51:58 -07:00
Igor Minar
8920381b44 fix docs css 2011-06-06 22:51:58 -07:00
Igor Minar
3776e08db0 new docs skin - WIP 2011-06-06 22:51:58 -07:00
Igor Minar
c1debfb81d fix docs landing page redirection 2011-06-06 22:51:58 -07:00
Igor Minar
0fb37b08e7 add resource merging 2011-06-06 22:51:58 -07:00
Igor Minar
2094bc8f61 make docs/writer.js copyDir recursive 2011-06-06 22:28:39 -07:00
Igor Minar
a1f3725c0f ignore non .ngdoc files 2011-06-06 22:28:39 -07:00
Igor Minar
525e444a0f temporary hack to strip all the extra chars from google docs 2011-06-06 22:28:38 -07:00
Igor Minar
fd112877f8 fix link to the tutorial page 2011-06-06 22:28:38 -07:00
Misko Hevery
11e9572b95 Move documentation under individual headings 2011-06-06 22:28:38 -07:00
Misko Hevery
b6bc6c2ddf fix syntax highlighting on the javascript 2011-06-06 22:28:37 -07:00
Igor Minar
bd7e68f12f process only tutorial files 2011-06-06 22:28:37 -07:00
Igor Minar
4738d49e1c new skin WIP 2011-06-06 22:28:36 -07:00
Vojta Jina
1abdc097b2 JSTD adapter for running e2e tests
Couple of changes into angular.scenario runner:
 - add autotest config (runs tests when document ready)
 - update ObjectModel (forwards events)
 - use only one ObjectModel instance for all outputters
 - expose error msg and line number in ObjectModel.Spec and ObjectModel.Step
 - fix generating spec.ids
 - fix 'html' output so that it does not mutate ObjectModel

Couple of changes into docs / generator:
 - rename copy -> copyTpl
 - move docs/static into docs/examples (to avoid conflict with jstd proxy)

Running all docs e2e tests:
========================================================
1/ compile angular-scenario, jstd-scenario-adapter
>> rake compile

2/ build docs
>> rake docs

3/ start jstd server
>> ./server-scenario.sh

4/ capture some browser

5/ run node server to serve static content
>> node ../lib/nodeserver/server.js

6/ run tests
>> ./test-scenario.sh
2011-05-19 09:43:56 -07:00
Igor Minar
e5419db6c7 fix indentation regexp for doc:examples 2011-04-07 12:34:34 -07:00
Misko Hevery
5b05c0de03 @require in ngdoc now takes reason for dependency 2011-03-11 14:16:52 -08:00
Igor Minar
5fc2b96b97 docs.css should not inline all pragraphs, only those in lists 2011-02-23 15:52:29 -08:00
Misko Hevery
55ce859998 fix documentation for ie 2011-02-22 14:48:53 -08:00
Misko Hevery
65243b7d60 corrected new lines in @link 2011-02-18 11:52:57 -08:00
Igor Minar
d600c608e3 markdown pre-processor should strip all the extra indentation
- split trim into trim and indent
- merged my indentation code with trim
- cleaned up some small issues
2011-02-07 23:56:51 -08:00
Igor Minar
f3a39a6418 docs should print usage for services that are functions 2011-02-07 23:55:02 -08:00
Igor Minar
f00b157841 @property should require type and description should be markdownified 2011-02-07 23:55:02 -08:00
Igor Minar
94bf24e3b6 fix angular.js file path detection in docs 2011-02-04 14:11:53 -08:00
Misko Hevery
882f412d57 Added remainder of the cookbook 2011-02-03 20:03:38 -08:00
Misko Hevery
245b60d69a addded cookbook 2011-02-03 13:26:48 -08:00
Misko Hevery
ba6b68b6ae changed the documentation @example to use <doc:example> 2011-02-01 10:00:09 -08:00
Misko Hevery
ed768ebc53 Developer guide documentation 2011-02-01 09:58:37 -08:00
Misko Hevery
e5a3acacad corrected sitemap.xml format 2011-01-27 09:53:20 -08:00
Misko Hevery
bd33f60276 Added part of guide documentation and supporting changes to doc generator 2011-01-26 23:31:15 -08:00
Igor Minar
7a48ee6aa9 fix deprication typo in the doc generator 2011-01-26 15:37:22 -08:00
Misko Hevery
d8acfe7389 add @this and @exampleDescription tags
(also removed markdownNoP, now done through CSS)
2011-01-24 14:23:51 -08:00
Misko Hevery
bf03eb007c Added SiteMap generation to the documentation 2011-01-24 14:23:51 -08:00
Misko Hevery
c2f2587a79 fixed example rendering, add tests for it. 2011-01-24 14:23:51 -08:00
Misko Hevery
70c74a9c4e add @this and @exampleDescription tags
(also removed markdownNoP, now done through CSS)
2011-01-24 14:23:51 -08:00
Misko Hevery
22c5b7059b updated doc styling for methods/properties 2011-01-24 14:23:50 -08:00
Igor Minar
2c0f7ffe3a ngdoc should escape content of pre in markdown 2011-01-19 15:53:58 -08:00
Igor Minar
72e554ffeb doc widgets examples should display angular src as CAO instead of DAO 2011-01-18 14:42:23 -08:00
Igor Minar
3bd96609e9 remove script.type attribute from example widgets since its optional in html5 2011-01-18 14:42:23 -08:00
Igor Minar
d73635d573 @returns type in docs should be wrapped in curlies 2011-01-18 14:42:22 -08:00
Misko Hevery
347be5ae9a fixed select with ng:format
select (one/multiple) could not chose from a list of objects, since DOM requires string ids.
Solved by adding index formatter, which exposed incorrect handling of formatters in select
widgets.
2011-01-14 10:30:00 -08:00
Igor Minar
ab040254f0 tabbing and keyboard shortcut for docs
- first tab goes to the search box, following tabs iterate results
- ctrl+s (FF on mac) or ctrl+alt+s (Chrome on mac) move focus to the
  search box
2011-01-10 21:23:22 -08:00
Igor Minar
4f5d5029c2 offline docs
- freezing syntaxhighlighter and jquery under docs/src/templates/
- for jquery I just used a symlink to lib/jquery not an ideal solution
  but writer.js is not very flexible and I didn't want to mess with it
- changed docs' index.html to point to the local resources
2011-01-10 21:03:50 -08:00
Misko Hevery
f534def0c6 removed unnedded files; switch rake to new doc build script 2011-01-10 14:48:13 -08:00
Misko Hevery
4f22d6866c complete rewrite of documentation generation
- romeved mustache.js
- unified templates
- improved testability of the code
2011-01-10 11:50:11 -08:00