From 8d02f304cf4d7c9f9ba9ca464b351f2042ec69d4 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Tue, 12 Apr 2016 13:08:57 -0700 Subject: [PATCH] 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 --- dev/dartdoc.dart | 6 +- dev/docs/favicon.ico | Bin 0 -> 3921 bytes dev/docs/styles.html | 70 ++++++++++++++++++- packages/flutter/lib/animation.dart | 2 +- packages/flutter/lib/material.dart | 4 +- packages/flutter/lib/src/material/icon.dart | 1 + packages/flutter/lib/src/material/icons.dart | 2 +- packages/flutter_test/lib/flutter_test.dart | 2 +- 8 files changed, 79 insertions(+), 8 deletions(-) create mode 100644 dev/docs/favicon.ico diff --git a/dev/dartdoc.dart b/dev/dartdoc.dart index 2d31151379..db59ba3627 100755 --- a/dev/dartdoc.dart +++ b/dev/dartdoc.dart @@ -41,13 +41,15 @@ dependencies: if (code != 0) exit(code); - // Generate the documentation; we require dartdoc >= 0.9.3+1. + // Generate the documentation; we require dartdoc >= 0.9.4. List args = [ 'global', 'run', 'dartdoc', '--header', 'styles.html', '--header', 'analytics.html', '--dart-sdk', '../../bin/cache/dart-sdk', - '--exclude', 'temp_doc' + '--exclude', 'temp_doc', + '--favicon=favicon.ico', + '--use-categories' ]; for (String libraryRef in _libraryRefs()) { String name = _entityName(libraryRef); diff --git a/dev/docs/favicon.ico b/dev/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..71344eea5b82203bc152444bcc4ffcabc901b907 GIT binary patch literal 3921 zcmZ`+2UJtp77axRO+gSsm8$eWXcCg3BsA$o1~9@8Nq|riNCJdGnivEJ1r?-7Q;JBD zCPSB|6zN4kKoAi54hlpR9Z>lJof*E%$yzV(-hKAI`1I#&BfSC&g0N@eay;uMlnII-dp5W+A zb+)pEVoCn$7#zt1uTJw1V6p)K7!ArC`s1k>X_~(ukpiW`W%n3R=6Dwd%S!K2sJ?Jn zXDeH2B#Dfd)=}41*N{bUOG`_`$T&}^J<8;}oH>KbdQ+(ZP%tw`5QUB2L5T_M}JPg7?8N@K4z==92)mBH;+0p(qR$kAP@s>OeL0p%7hZ2xNDl%iM$? zIQuf#jUdT*43$K7B$50OdsX=FPNlWfwbZ|B_cOkWVc^|!wC`MfJG6T!^VA}^nXZ5R z0wB2M&IX$S0Nfqss8fzKmbWfE0gg{azYaYAMK_ATn;6HTnCMzFI{#MjkeY{*Gk@mo zvhu5vxmShRS$$ZQN`=k1Q&K(rd4AUzR~~~#U7*KaGAp!wg5{SfQc$*an-{&_Kl?mv z>r1L?wM-+X`c|&>#~i=aS;`=Md8cJ(r)49j`s8VQU_QT@Op=i_{Ump^5bMreU=etf z_;$3j^E5TE{#qVVgYOVxb;ZH7yujL>8_*j*l_lBA78`y1_ApW@|7?b*N+v}6cUPIF zv2wF7i>`pcewNAP^0fd_#XF2IgcE)IxsPd=+rm=WfUXt5?!$Nw`?+U-v=`j9+Stip zv4z-$S%I^I6fJ|HL#q4<{z-rvuULy&ol{mjW8mS%kl?kK*`S_gskv$K4JxOKWJ!~{ z<+At(F|gce)DVsK9ONW=^3?fi`SFq-xm?=i)$GFc!qNDFr=A_j$;r~fB9?;99DPm& z*GOR1p)8P6Ot;AM$p}ea=Qrri6?M0etiT0_92=KwYpCtnd_a@UV)_cnfbT&G_+_4w zFcCXurfs?AUX*>PRxRyLmx0751w)q+PYO^?0IQlIQDu9IA0eNpS}SyOdBD-Mea$V@ z9|F*QwL-e_W;T!UmQB6^_4qA2>oMK;DvwScC|F)vLD%wtyNhKyO$6upId9y0AqRS- zx#?nL>z1iuA=y$Dc_X0JAQXB7SDT!Woy@pXN=uDQUzn?R2qG1ZSZcyHnCtzZ>g)7XGB@I-`6`&h}q0@Bj z1nd>~Z`<qXy3jHy~W{>zvWX&h;O#h&h|0ExI-_ z|Ch65-b=4qDo#8zv(*hTxKeLWHNTOOMjjM7@j4LW2q8$zchdc)0(p=b^~1vhuh;Xr z-27Kj^o3g+9~4ssAAg=P z4dXN1aPbLdY4gPEnz$VRZ3fkp8AX;=^eq|nMzt?2kQO9W;vNS}b(LVO3=Q1X`bvNp zUdbWFP6x2eBe)b@$)m~g3};k-=+<^$^V~ZZo?G2-h&rxMDf1k$+EF@Q^L3 zvS$#(+rM7lUI|u2j(HX6GBkPAqOGBP!v9)L&Xb*{L4o9?fMBTnXPoa!dxx*Vg8C7Z z`f-JUpvRjL{42o?c5m%LCQIU~cN%Hgl$NFP_K(Mei(8)RnW+JA)ola4^k~5&E&`eA zxSDrZRW=W3uR>!mmJv;*FFS>_g|cg&g$XI?%+`9hvTjOR$f5Zd53^QMn<6d}w0u5W zCY;~WtJ#2)AFh9N1(@Yc$LQ66nNc_niN7qQIu&oq5y^VIfqX!aX9EYSYqun!}S zmXzI6wyl{Uf8b?FM*2k|{qg2oWQ{bOo>fB9lHFNa*`wAVV%JlOp~ULgB70X@Y*5$p zcn~-krQ_xFaKNW<=&4N?PCuX+2~-Q6`|VG7)a)PTYo2k34~xzmot&5C6MBstbgG_S z*O6RLnus^0^A}`Av8SydIaBAkjPuf!!-IYM@UAm4*hZc_og~o_iEl1krBjR;K zn*3`3&hH-#91KnBO^vivn2x^#qZpX7Z9)Wf>yB(bptMIe#|QJqWotha*$&2dgyD0& zqs+!^=SPrptw>HShDhw2TH2woARs0raS=4}O18mI?}gXg#FC4)z`G8dNuJtYQ$lwndkoVpQ74mN)rqM^5?5e7b$^P$D{AQN(YokBnnr5J zhdj>F0`W%bb>RHLky)7eMU7H{(#{c`tcpx*v$5RB#d*3!{UFVA9Hisb=GdHKG8?)y zavUuiuJ6v(7CP_KJEc&zxI<#o@Twx3;4jxZG@Ju9A-LFN_50u1cQbfctA3k!>z1oM z9sk5qFdf}R%3FZnqj_DOxVgNY{fDxp^V0(+Vm1knMyqD31~t8OI6Ng3PFT-~T?J^O z4<~$`L=uZx%%GU4Aop1=%%;KY-pPGdSM<_L1U{j#!F(iAWQ+Y8id5iDd{k*SdtE0&XXzbZgv3 z)qcmE_`Wl8nj@-r;u1_zHLq6e{HnU!L$qRLl!vmUXZX5JHdpE5>ith8-cp>}PHNVA%uhDHc#_xKTbc}plQS_L`U%Q_6 zxM$Ft5nejc-1Ow?3yopL#Sehyh@`tUmmXS6J@iBWVX^yWsKoxmtKvUEE=TkZOVFm2 VaGjiy#O|M5b7O1NeWU+e_#bq)g%kh) literal 0 HcmV?d00001 diff --git a/dev/docs/styles.html b/dev/docs/styles.html index e3dc2b3016..40a1890e7b 100644 --- a/dev/docs/styles.html +++ b/dev/docs/styles.html @@ -9,6 +9,7 @@ line-height: 1.5; color: #111; background-color: #fdfdfd; + font-weight: 300; } h1, h2, h3, h4, h5, h6 { @@ -18,11 +19,25 @@ h1 { font-size: 42px !important; letter-spacing: -1px; - line-height: 1.1; + } + + header h1 { + font-weight: 300; } h2 { + color: #111; + font-size: 26px; + } + + .markdown h2 { + font-size: 24px; + } + + section.summary h2 { font-size: 32px; + color: inherit; + border-bottom: none; } .sidebar ol, @@ -30,8 +45,59 @@ font-size: inherit; } + .sidebar-offcanvas-left ol { + padding: 0 16px 16px 0; + } + + .sidebar h5 { + padding-top: 0 !important; + text-transform: uppercase; + } + + .sidebar-offcanvas-left { + background-color: inherit; + } + + .sidebar-offcanvas-left h5 { + border-bottom: none; + padding: 0 0 16px 0; + } + + .sidebar-offcanvas-left h5:last-of-type { + padding: 0 0 16px 0; + } + + pre, + pre.prettyprint, pre > code { - font-size: 14px; + font-size: 15px; + } + + pre, + pre.prettyprint { + background: inherit; + border: none; + margin: 0 0 15px 0; + padding: 8px 12px; + } + + code { + background-color: inherit; + } + + dl.dl-horizontal dt { + color: inherit; + } + + footer { + border-top: 1px solid #e8e8e8; + height: inherit; + padding-bottom: 15px; + text-transform: lowercase; + } + + footer p { + color: #828282; } diff --git a/packages/flutter/lib/animation.dart b/packages/flutter/lib/animation.dart index ad8efec305..eb86a879b2 100644 --- a/packages/flutter/lib/animation.dart +++ b/packages/flutter/lib/animation.dart @@ -4,7 +4,7 @@ /// The Flutter animation system. /// -/// See for an overview. +/// See [flutter.io/animations](https://flutter.io/animations/) for an overview. /// /// This library depends only on core Dart libraries and the `newton` package. library animation; diff --git a/packages/flutter/lib/material.dart b/packages/flutter/lib/material.dart index cd1f593336..d158559e24 100644 --- a/packages/flutter/lib/material.dart +++ b/packages/flutter/lib/material.dart @@ -4,7 +4,9 @@ /// Flutter widgets implementing Material Design. /// -/// See https://www.google.com/design/spec/material-design/introduction.html +/// See +/// [www.google.com/design/spec/material-design](https://www.google.com/design/spec/material-design/introduction.html) +/// for an introduction to Material Design. library material; export 'src/material/app.dart'; diff --git a/packages/flutter/lib/src/material/icon.dart b/packages/flutter/lib/src/material/icon.dart index 3679f8b1f5..7f18d42a70 100644 --- a/packages/flutter/lib/src/material/icon.dart +++ b/packages/flutter/lib/src/material/icon.dart @@ -6,6 +6,7 @@ import 'package:flutter/widgets.dart'; import 'colors.dart'; import 'icons.dart'; +import 'icon_button.dart'; import 'icon_theme.dart'; import 'theme.dart'; diff --git a/packages/flutter/lib/src/material/icons.dart b/packages/flutter/lib/src/material/icons.dart index ed6ab2a0e3..4c09a62a6b 100644 --- a/packages/flutter/lib/src/material/icons.dart +++ b/packages/flutter/lib/src/material/icons.dart @@ -38,7 +38,7 @@ class IconData { /// /// * [Icon] /// * [IconButton] -/// * +/// * [design.google.com/icons](https://design.google.com/icons/) class Icons { Icons._(); diff --git a/packages/flutter_test/lib/flutter_test.dart b/packages/flutter_test/lib/flutter_test.dart index 27db964486..ae88fd54b0 100644 --- a/packages/flutter_test/lib/flutter_test.dart +++ b/packages/flutter_test/lib/flutter_test.dart @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -/// Testing library for flutter, built on top of package:test. +/// Testing library for flutter, built on top of `package:test`. library flutter_test; export 'src/instrumentation.dart';