Commit graph

86 commits

Author SHA1 Message Date
Daohan Chong ec8ca8606c Add dashing config file for generating docset from flutter docs (#24374) 2018-11-15 10:57:02 -08:00
Greg Spencer 1561815e6c
Revert "Generate a zip file of offline docs and a Dash/Zeal docset. (#24244)" (#24313)
This reverts commit f3a4f7e86d.

Accidental merge on red.
2018-11-13 16:02:34 -08:00
Greg Spencer f3a4f7e86d
Generate a zip file of offline docs and a Dash/Zeal docset. (#24244)
This generates a zip file containing all of the docs, and uploads it when we publish docs, as well as a
Dash/Zeal docset that contains a feed of the docs.

Addresses at least part of #9955
2018-11-13 15:58:06 -08:00
Todd Volkert df57dc9da9
Add content to the API doc landing page (#24193) 2018-11-11 22:36:47 -08:00
Todd Volkert 515dbcba82
Update API docs landing page. (#24073) 2018-11-08 09:00:47 -08:00
Greg Spencer 094f93dfcf
Fixes several bugs in samples, quotes HTML properly, and pre-compiles snippet tool. (#24020)
When converting all of the samples to use the snippet tool, I encountered some bugs/shortcomings:

1. The document production took 90 minutes, since the snippet tool was being invoked from the command line each time. I fixed this by snapshotting the executable before running, so it's down to 7 minutes.

2. The sample code was not being properly escaped by the snippet tool, so generics were causing issues in the HTML output. It is now quoted.

3. Code examples that used languages other than Dart were not supported. Anything that highlight.js was compiled for dartdoc with is now supported.

4. The comment color for highlight.js was light grey on white, which was pretty unreadable. It's now dark green and bold.
2018-11-07 08:29:14 -08:00
Greg Spencer 65d3ddd5d1
Dartdoc snippet extension to inject full featured code snippets in to API docs. (#23281)
This creates a custom dartdoc tool that will generate snippet blocks in our API docs that allow the user to copy easily to the clipboard, and will also embed the snippet code into a template to show it in a larger context with an app.

This PR adds the snippet tool, a template, and a couple of HTML skeleton files, one for snippets that are designed to be in an application setting, and one where it simply puts a nice container around existing snippets, making them easier to copy to the clipboard.
2018-10-23 13:50:24 -07:00
Kathy Walrath 387c458a98
Really fix the flutter dartdoc link (#22266)
It turns out that #21888 didn't really fix the link, because *this* is the README used by dartdoc for flutter.
2018-09-25 14:35:08 -07:00
Ian Hickson 6d134e0c86
Animation API improvements (#21540) 2018-09-23 00:43:05 -07:00
Ian Hickson 7d5e5ebc94
Fix broken link (#16965)
See https://docs.flutter.io/ to see what I mean.
2018-04-26 16:06:04 -07:00
jcollins-g e9541729a3
Update dartdoc to v0.18.1 and fix API readme (#16080)
* Update dartdoc to v0.18.1 and fix API readme, borrowing from docs.flutter.io
2018-03-30 12:19:44 -07:00
Ian Hickson b24a3a118c
Update some READMEs under dev/. (#15712) 2018-03-19 16:41:36 -07:00
Filip Hracek 10144fa5f9
Update description on docs (#14660) 2018-02-13 10:49:47 -08:00
Devon Carew 688a571c71
update doc styles for 'implementation' sections (#14441) 2018-02-02 12:36:03 -08:00
Matt Sullivan f44007c810
Add survey js to docs web site (#13210)
* Fixed typo in navigator.dart doc comments

* Added survey js to docs template
2017-11-29 09:07:04 -08:00
Greg Spencer 909406ba25
Consolidating .gitignore files. (#13002)
This consolidates all of the non-template .gitignore rules into the top level .gitignore, to ignore common things more broadly, with less maintenance needed for the .gitignore files. Does not touch the templates, so that they still produce needed .gitignores as part of flutter create.
2017-11-28 17:06:57 -08:00
Devon Carew 00c4c7b023 de-emphasize the footer of the generated docs (#12514) 2017-10-13 13:31:32 -07:00
Dan Rubel 3a31c35ba0 Rename .analysis_options to analysis_options.yaml (#11594) 2017-08-15 08:46:42 -04:00
Sarah Zakarias d97b13b5fd Add objc doc to the dartdoc output (#10905) 2017-06-26 12:15:24 +02:00
Devon Carew 2e96550fa0 fix typeahead css (#10325) 2017-05-26 09:52:03 -07:00
jcollins-g 7fb798f5f1 Upgrade dartdoc to 0.12.0 (#10296)
* update the docs css style so the generated dartdoc matches the new flutter.io

* Change to 0.12.0 dartdoc

* Review comment
2017-05-25 09:42:55 -07:00
Ian Hickson fbc5f74cad Attempt to de-emphasise the source code section (#10215)
Fixes https://github.com/flutter/flutter/issues/9377
2017-05-22 09:55:40 -07:00
Devon Carew 668ae8bdda update the font used for docs.flutter.io (#9337)
* update the font used for docs.flutter.io

* update to use the flutter primary color

* update the header background color
2017-04-14 08:55:16 -07:00
Jason Simmons 6873cdfe30 Add a fake package that generates a link to the Android javadocs in the dartdoc output (#8032)
Fixes https://github.com/flutter/flutter/issues/7963
2017-02-09 16:12:09 -08:00
Ian Hickson 49b5701224 Minor fixes (mostly doc consistency) (#6780) 2016-11-09 15:05:56 -08:00
Seth Ladd 17aeb2f5e4 fix transparency bug for sidebar in mobile (#6764) 2016-11-08 17:29:05 -08:00
Seth Ladd b34b453c6c Docs colors logo (#5176)
* update the color and logo for the docs site

* update the color and logo for the docs site

* remove unused file

* removed unused script code

* tweak styles for inherited names
2016-08-01 15:43:10 -07:00
Devon Carew b8d15a1e61 hide some unnecessary headers from the generated docs (#5020) 2016-07-22 22:21:04 -07:00
Seth Ladd 1ac08b2632 Firebase hosting for docs (#4871)
* configs for firebase hosting

* use the implicit FIREBASE_TOKEN

* don't print every command (lowers the chance of printing secret env vars, and for realz only deploy when merging into master
2016-07-12 12:53:47 -07:00
Seth Ladd 707fe582a6 Docs homepage (#3908)
* put an index at root of API docs bucket

* ignore all of dev/docs/doc dir, fix a bug, remove private names from doc gen script

* tweaks from review
2016-05-16 08:28:58 -07:00
Seth Ladd 7e4a91f340 add a webmaster tools verification file (#3902)
* add a webmaster tools verification file

* also put the verification file at the root of our bucket

* add comment for when we can simplify this script
2016-05-13 12:27:06 -07:00
Devon Carew 4678c12098 find all repo packages (#3368)
* find all repo packages

* .dartignore
2016-04-15 20:25:57 -07:00
Devon Carew dd81a21c93 small change to the generated dartdoc styles (#3290) 2016-04-13 10:04:35 -07:00
Devon Carew 8d02f304cf update styles for the generated dartdocs (#3276)
* styles updates for the api docs

* update library docs

* use the new --favion and --use-categories options for dartdoc
2016-04-12 13:08:57 -07:00
Devon Carew 3cfa4d39c6 docs cleanup (#3196)
* some docs cleanup

* update styles

* remove unused file
2016-04-07 15:27:43 -07:00
Devon Carew 9a4c2c681f add a dev/dartdoc.dart script to generate docs for the packages/ packages
* add a dev/dartdoc.dart script to generate docs for the packages/ packages

* remove description

* rename readme

* change to using --include-external

* move docs to dev/docs
2016-04-05 12:33:12 -07:00