Commit Graph

55 Commits

Author SHA1 Message Date
Ian Hickson
449f4a6673
License update (#45373)
* Update project.pbxproj files to say Flutter rather than Chromium

Also, the templates now have an empty organization so that we don't cause people to give their apps a Flutter copyright.

* Update the copyright notice checker to require a standard notice on all files

* Update copyrights on Dart files. (This was a mechanical commit.)

* Fix weird license headers on Dart files that deviate from our conventions; relicense Shrine.

Some were already marked "The Flutter Authors", not clear why. Their
dates have been normalized. Some were missing the blank line after the
license. Some were randomly different in trivial ways for no apparent
reason (e.g. missing the trailing period).

* Clean up the copyrights in non-Dart files. (Manual edits.)

Also, make sure templates don't have copyrights.

* Fix some more ORGANIZATIONNAMEs
2019-11-27 15:04:02 -08:00
Ian Hickson
1ce4a4f36f
Make sure all our .dart files have license headers (#44467) 2019-11-08 16:53:21 -08:00
Andrew Brogdon
691977755c
Adds DartPad option to the DartDoc snippet generator. (#39924) 2019-09-10 08:36:14 -07:00
Andrew Brogdon
5400323648
Updates CORS origin for snippets. (#39780) 2019-09-05 16:08:48 -07:00
Andrew Brogdon
aff16348e7
Adding header rule to FB hosting for API docs. (#39345) 2019-08-28 10:21:15 -07:00
Greg Spencer
67ee3e191e
Add anchors to samples (#35906)
This adds an "anchor button" to each of the samples so that the user can link to individual samples instead of having to link to just the page. Clicking on the anchor button jumps to the anchor, as well as copying the anchor URL to the clipboard.

There is some oddness in the implementation: because dartdoc uses a <base> tag, the href for the link can't just be "#id", it has to calculate the URL from the current window href. I do that in the onmouseenter and onclick because onload doesn't get triggered for <a> tags (and onmouseenter doesn't get triggered for mobile platforms), but I still want the href to be updated before someone right-clicks it to copy the URL.
2019-07-10 16:48:20 -07:00
Kate Lovett
054d9bb2f1
Updating dart.dev related links (#32641)
* Updating dart.dev related links

* Update packages/flutter_tools/lib/src/base/context.dart
2019-05-14 10:35:00 -07:00
Tim Sneath
529189791c
Replace flutter.io with flutter.dev (#30562) 2019-04-05 11:39:30 -07:00
Michael Goderbauer
f0c2be3c1e
Fix links on homepage of API docs (#29641) 2019-03-20 14:42:46 -07:00
Jonah Williams
83614757be
Revert "Remove the old HaTS implementation on API docs" (#28748) 2019-03-01 15:42:43 -08:00
Ja Young Lee
d1cb00bcda Remove the old HaTS implementation on API docs (#28683) 2019-03-01 14:05:16 -08:00
Jonah Williams
2acf6fdb6b
Outline for survey implementation (#27305) 2019-02-20 15:28:28 -08:00
Greg Spencer
dff25a3055
Fix Dashing rules to use new dartdoc CSS entity markers. (#27818)
This fixes the offline Dash/Zeal docs generation to use the newly added dartdoc markers for different entity types to make it more exact when finding entity names.

Bumped Dartdoc to the next release.
2019-02-15 08:40:19 -08:00
Greg Spencer
262f12b4a9
Remove remaining "## Sample code" segments, and fix the snippet generator. (#27793)
This converts all remaining "## Sample code" segments into snippets, and fixes
the snippet generator to handle multiple snippets in the same dartdoc block
properly.

I also generated, compiled, and ran each of the existing application samples,
and fixed them up to be more useful and/or just run without errors.

This PR fixes these problems with examples:

1. Switching tabs in a snippet now works if there is more than one snippet in
   a single dartdoc block.
2. Generation of snippet code now works if there is more than one snippet.
3. Contrast of text and links in the code sample block has been improved to
   recommended levels.
4. Added five new snippet templates, including a "freeform" template to make
   it possible to show examples that need to change the app instantiation.
5. Fixed several examples to run properly, a couple by adding the "Scaffold"
   widget to the template, a couple by just fixing their code.
6. Fixed visual look of some of the samples when they run by placing many
   samples inside of a Scaffold.
7. In order to make it easier to run locally, changed the sample analyzer to
   remove the contents of the supplied temp directory before running, since
   having files that hang around is problematic (only a problem when running
   locally with the `--temp` argument).
8. Added a `SampleCheckerException` class, and handle sample checking
   exceptions more gracefully.
9. Deprecated the old "## Sample code" designation, and added enforcement for
   the deprecation.
10. Removed unnecessary `new` from templates (although they never appeared in
   the samples thanks to dartfmt, but still).

Fixes #26398
Fixes #27411
2019-02-15 07:48:49 -08:00
Janice Collins
6bb4b12633
Update dartdoc to 0.28.1+2 and fix search text alignment (#27559) 2019-02-06 11:10:59 -08:00
Greg Spencer
02dbb08cdc
Modify offline docs platform family for Dash/Zeal (#27053)
This changes the DocSetPlatformFamily key to be "dartlang" instead of the name of the package (usually "flutter"). This is so that the IntelliJ plugin for Dash will be able to go directly to the docs for a symbol from a keystroke, instead of needing to search all the docsets each time.

Without this, flutter isn't part of the list of package names it searches. After this, it finds the flutter docs because they're declared to be part of the "dartlang" family of docs.

Dashing doesn't have a way to configure this, so we modify the Info.plist directly to make the change.
2019-01-25 08:48:52 -08:00
Greg Spencer
625a37b86a
Adds favicon to Dash/Zeal docset, adds OpenSearch metadata. (#25178)
This sets the favicon for the offline Dash/Zeal docs.

Also, sets up the OpenSearch Description metadata file so that people can create custom search shortcuts for the API docs site.

Fixes #6412
2018-12-11 09:53:33 -08:00
Greg Spencer
f827ebf357
Merge analaytics from docs site and flutter.io site. (#24825) 2018-11-28 15:37:18 -08:00
Greg Spencer
f20adcc428
Add docset generation (#24322)
(re-land of #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-15 15:05:57 -08:00
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