From 10cd1950cbfa8d4d6ae23204ea42f5afb67f94d2 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Mon, 20 Feb 2017 13:41:20 +0100 Subject: [PATCH] =?UTF-8?q?We=20have=20a=20logo!=20=E2=9C=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- MANIFEST.in | 3 +- docs/_static/attrs_logo.png | Bin 0 -> 7639 bytes docs/conf.py | 157 +++--------------------------------- tox.ini | 2 +- 4 files changed, 15 insertions(+), 147 deletions(-) create mode 100644 docs/_static/attrs_logo.png diff --git a/MANIFEST.in b/MANIFEST.in index 483a3a34..354b1814 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,6 @@ include *.rst *.txt LICENSE tox.ini .travis.yml docs/Makefile .coveragerc conftest.py recursive-include tests *.py -recursive-include docs *.rst +recursive-include docs *.png recursive-include docs *.py +recursive-include docs *.rst prune docs/_build diff --git a/docs/_static/attrs_logo.png b/docs/_static/attrs_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..11b6e6fe3f99e87d7e7065d53c0fd6ca11f0a621 GIT binary patch literal 7639 zcmZ`;c{Egi+`dDWY}uERWn`Byc3B(SWNRXY?8ZKX$UX_7A{sJ`Ffx*@EZLcUs4%uh z*+oM3?2Yxkz3<=eJ?G9n_s;ix&b^=Qc|OlK*~-G0mFYYa0069}CU7Kptpd;IjP&4d zOq&)fcsUbnU~0_>9#M?$N#On2K$APc0KnGy?}TK^vRwcl3WONm4!IeC3JG%w@&LlZ z!sNZtzQJxTfgbV!L7utmSI+~$MQc;IzV!qAT3%$7pl$em>;UeY&wQDm(>VC3+!f1v^ubp?;07W;HyZ7sQd1xr=R`aWk#iF#<;C}q}>Uxc5 z|9m66!Ff*Uc{=iuJ$y$ABMKdN<4-)R_s#x8LDH~2=K0no&SYO;RfT1)n6s<>I=o%& zI1X31a=-yNRm-hZlH$w73b*7HA|fNjXlZFT=>O=W+So~MKqUhS_SPHt(AV}d=@#U{ zU6D9>;LS8mJRXWOL*GC|bCQU-k>uZx$VZo8P8M)e-~uq|@Rk*NkmW=kIiLJC(<1LxHb}*h+M8a zK0eNRd_0^0t`I4=uSauWUI?klqGaR&_VlN4Xqu_?%g9OFnfRV&;P=wfo%2t++8Ac4 zMGo8+wzH|dQtNigadgXfgiq9V^w`V|_W^NJi3q$P<^^y1KiyVH?w2ko^^b z!Yz8Ut3qjKMfV_sYu9fA1jrLbx)}sTIsa^fljYeGR>(DYEaqkk^O>p!;7_-at%HbQ zIIVal!cbB|f*yju>3QQIfn9qkB%-=MXc(@(MQ@^-JC%4KD-VQ77o)4{+3PrE0x$~O z&C8cNSYoPzG84?z{TZLbq3N~tZ&XJH$v1$BU|J;iO{tVsOJDXFv62>+3*{b6O7Ps+EZUu(ksA8C{6?NWQpVI0g zKaxkcjwts`E0~@7=^3b>Q-d21D^A)sk?Axs@9g4Eyv?Z15X zwn6Vri$1b9ikp0-a(Cp4oDFg1zz6t2XI1f#+GgkeR&BQSBeAT^*Z&gdSSNWA@>`UU zNp2A&aROWb5sR#MSHj&;TQi2HuTi7gcsWKmhi)Q!4zb8{d`t-+!MB!2#axEPe#xq{ z3$>}N4m@i)>h~J!MDvHOL=zs8=feM^v@nepXquYdpuHkpJe}9=-ew=5Kgn)!!Q#fy z_;u-d^^G$r^4e0mQZ4yO>z4>xIO_H{rr)%SjG{u6`>jMuV+6!&2$x#n3{1jwmL)zwNg>Iy!o< zBtrI9`Clna7f+6sXIBc(t;onobVx|Z8JK~B_>1ma+}B`tnPwb-`ik4{UFWvud&AOF zQ~Pm}X-}V;RXQ|Q12f|?KQcyE70tKLt;ju+&57v0koI}bAgK!Y?YeLQOqH>68K_X2 zlX(0CEzCZl$$R)LV97Z&A}J}^F7V9gRG|2BS1Q*~Bx}dtptDqYK7--=L!IP+I=Pj? zh@P1&qRliMdXEbh%UhDFZOJ5xHZ7r?+uzxd>s#F3a9e1$5)}6}EUf++i;%u=Dey-TpMU`Goh~Pa2XKjE4^Z?Y(0E zSpj_VbkL!n(dV|@ZGkSi*fS>*Z%ms>Y%`-`8bG6uaKf_pweu`=<>E(~W()yc)PgzD zdpfIkK7$-3+|sRh?*)UuoO+JWxJa?Xxfxr4_nUndr=Z(HMV5!Q?c2b)PtVHsHh$=) z+!5kJ_S{excEkGI`wf&PnG3%qW6DU_k40M$6t zf4IM)8~3$R$D>^g6_e|obKRWM;uRHjgaD#zddz_UFg2D@HysMPu_GwaiIU0@OrZskEz(>%N2=4 zq@(nF5paIC^9|-ss5trPVsCX^>d?fX^0O_3^eF@8;%-(EZ#EU$TfH}IpK4SnYB`$G z?H-3~&O|b7Q;({+k~^=1pm$m|9rTTfBbuGG@qf#VLA#!Vc&8xM+`dYmPk9hsug)oY z$PDW)?|+i6?{BYu+vO$P@M`eBc2%gIo755)IQ&Hv(1Hk}7K-5^Iw^&w$1!%T9Hb(h z{UL5;{FYD7o&>7WVMx2(3UQnd23H-m_I|l(T0H(QBkYvzDAGseKXi9o!7Py#Oyq0# zbVk2_55=vSYb^$ns>@?K6sE=EN9i}XPRzGk){xxDhl%#@mYUG)={rq#Q8A;{<^I_v zqE9PV0z?T_{}l}k>h!dJt}Zv0xy1$qS@d)aBzJTzUI$1_XXl=s^x& z9&DSIjA!Dh*F2914{pTApA#A&A8B+bIKJJ}fgW5)gZ~|?4Y2=m$rCaxxUI)HTdX@JaP6A(#^B)K4T|yx+ShkQgrEg^kkOimb9ytoXSbfW zu50bcr;OdQsQCw@i7r=3W@mmxiSH8BQB0*oCcxO&PS^mb`O519bK5?Cd?%$>WIL8_eV*UW)QaHgSxA zwd*D4#9ZEoCW*k%kUz~yV7zaBO?jh3OhP{+ej{C zFwME;$y87_E`a~y#fw!ADxJxR6EeBoot>S!U9RtWfLGn~LCy3G4Cg8xTO&4qc0CEB zk;1t*^($b)?qsPr1nB2HOw3bNADWuF3|6HDP_}Zp*DuK{*MAo5U%u=E!kmTN^z&t} zFBR3)!HJ0rE(>Ab>{F5KLsS3SN9(*-NY1VB!^6XXxY#VGIx8S>5y#m&X$d||U~hK{ z5I_VX88=ZB<#y|TuZOa6{7BYM^AnT$gq8Bl4NSsSfndd~YU@xmRNhl&MrnD4(`6B{ zEnJTQ(7}IrfvX?MVNcW2!g7e=^++FPOmxk%c0ZZVK5G~D@;Dw_;9cKCG?jS4CtIxZ z`0LrdJx0+FM9R|UgR3VpqMbZ|JmgO(*-bJLr|Wm;yVF2hTg>qRPYyBqQ4;viXQFou z)3kdv3r?RRd&O!poL^9|B@cHhSi&YxAJjOR_3`7!M>Q+grNfHebY?b8fut=<#zf*p zMWX}SBR2L_bU)*<`cUm*3#{8+$;aK@Je$R@El?Rbtck3AO$~DG3>6vnt3PT05kzxP{=_;B2LtlvwKQ_kGl0}01Petv$McjZrA z%x4;fes2CHR-x<^wqkD*>mG@smZ0SC!|Z#22u+)vY!Xo z4?Z+5m?5XZIiM-)%$N=3+qXInz2<9~gSid#IY!}HT3REJKm_Ju0|5@@FxG7de1GeL zc~J`(q*T+A+3*mN+`e_;^XGE{hs5uPg;n*=2Yp??$uRhdyaumLN+KXi zZ$LHAI@6FuU?rKzrIV8r2=}9AvVU!gT2yGE)o*b^FT^3y)!~sUU%(l16r6FB8+K|X zz5B>a0#=n^4I-%>rS_GQf1B`pQ6V32q{Gp8N0602aWgL{0oh}}D(owbTfas%%R5Z^ z%_aW}0^3kB-=+CpB^bDrwO**9(_>nvmoLU5Jd|+97MT$d5m^gCjb%8hlD(6B z!r|3ENnjO9xJW*F?VY3LawX_uW_?Xf@LlEet(mwg<4yBJp2b-Ja|(j=^~S627u3)W zDk>_wG#DP8ZYxe`6Gh=E10r*&=|mICq*++VX%JFE@$M)^Leu}UqT1+4yFg4wQCoXJ z&VuiCp3b?=P|;4UY$`ppiC(YFIJ$qq5O8u?U=WOr9`f1=ph>wmK|52FL)2y{aQ|}H z-QBG#PSE4wBlW&`@#55xXeLHD6@H^^C{+5o0U(i`jPAwnX0*%N>cL|nGqjM`4cdGp zVfLY))yyAKQ&Uw@ZQTK;CEZ_ee+S%9mNdSmv5BoTOP(n}e$b6YJ&GGsY@Vs|^ zK`J0DZ2u1VsK3C&Wg$%Y9HfjIcQW!ouKIKEM?mD{ zkEof9;OX6!kt!hYZZbiR;||$xd`!|DxWX)IAyxbd@|5#N7H$HNlOzP=8X3CiI(Pw3 z4aS=$mpHGmva!7iRm>k~XZU#f_OXPdZgTuorF+v^B!3Fw1EU*nO1AZxq z2#{9KAxaGml5EH=DM`1+?Zc$G?|+i!8M|#d|4n(VPfCXf4%+fSGvulp|EDS|)PTQ^ ziS&NKQRw%NYZLX0o=%qt`BKF(We&LpNl&t=mOYtVLtwF_*@{WR+5`X0e0%{8AgB{= zjHSj76%7OgNwr^>wy_BfD;`c;yt5%uV#vkO`cdI&MzAdy;|Y8Zj>^_stuselTVG$V z*`gj90+r4Sm*KT^q@d=%fu{3321o8eL0hYZg@r|E&C9e96Lsu4Y?Bv%qFYZ1*jlOv zHy&kqtd(1poM+1Ni0&(m!)|G_bxE>xGzhD((6F&{Xk4yN`|SFDBXUd_lVR_v`naj7 zNhjb=R@tY+g9AtUKk>&5z&}aIb-@?1lWFbPp%An5R*m5`HV@#{vX(Aw$$aA+l%0#m zM}0SMR+;fKHG((Kru~G1WBY$(3xVfC`%1S9Dp&aaqYj-sLt0YKTP=kg+yMq?AmgeE z+eRfpkteJ4lJn8i^Y@6pe))~nhePDm+|9=5>|dR3j(f)Ns!$ov1>x|qAAU499Yy1d zwv@J~eI}lMp7Wi-`}!9Oz*?#tDQ&thH^D;n37q zTyGw2F^LL#a2oto+5*S4P^gSAzLVT86}IC@oBG5166ex>Lpx<6Ecm9U=VFt|r3`ih zJhQU^?25}mHoJkswmQc%+2T|hekpFID=aK5Pf65g3*+PCZ$lrKx(7+c-}XX1fBbc6 z=eh8)PfjRn@KS{(AVPQ>>abv1e{(iR#W!{B$A(wOO|DGrOVGcn;35qU|M$Yl+JGxb zcKugZ3cRWXwcuTk24e=QRA>52?nk3}IWvzszAn|q<~y7PAu+_&^(P@{p1it^8A(LdX z8qM!B7PiAaq68ZY&=4xD%cABBL^yQYecaX145L;Dx9$2qzq zJ;ocmuI3}VX!Y{tm0ue7yc1|?oZK^z@(h7(*D~{OA>)0Ljf$RZQ*%N;5^1aOtN=Nx z@c8^*`yJ_d3i;?R>ckZ^N=DDr=39Vz9Bli8-KC)9-1K^MSp);#9f>IQJo-JXs&qw* zMQOXmV)3oM^n6$ljvrH&^t&paorv8sZmJCHD-RsM@S)-nO&VbiH7*kW=GWxyv^@Hf zE;}cQ7XrIQPSB?RO7S@DJS9L+Ctr8{el8n3rVO=lyOq#VYAw@4-e9vT@V3Y%-r0p1 zCfFRibSThY?9nzxG)}4-$UMGMBoB;Ms?J-bo4CImi3Y`ia{sr>RBt~GF#T6+M<}Nn z;ak5}WG|NkzaU3Up)}f1O-5%kX%+v@uWU1Z&}H`pb9e}cjD7quw~c)Hs&hm!C#YlW zq$|X;gVYgkX12H%d`sNgWyB*^Gf!x{$gM*`hizuAsWO1mz+r%F3u&OyGtF~URzsxwzI$g!xVn{%c^48*e*6UHYLfG%_c7ODQz*M5g!>Y~_P-&{Ldkf%?n4=+g>A9t-*!ZGR|9 z_V9(8`s7Pc8MrRxX6lsszkScL+H(%2V+7CS77v`KdpA}(I3Mb4D6S=Enm!D7BAZPR!1Z-}NgeoBh+C zR!dp{ue1YaFu68mlqj`!_wJ08={m=+LqkLKi$!0f1F3UWXE-#Z13t929&6|x>?Rws zd0YWmyx&5?65S_XL3B=vQPISd$=9!6gH-Tt+E-_-7UEyz#S4VQt(aW;O6w^m=|p4! zbA##e$A`H5I^%jH%#5Hf`o}7>>r~VICo@OCsmZ-V9Eeh1e9sjBlaR2md^%632GZP= zPtL7w*Z!AXcExkQ6Rvt>KdW3>ne{tWvJIaYAMd|LeGbi%BrisDx$OktoWlxV5&6v|>-FUAf{mM~4E#`|XFwnseIt7}I9oKT?5PcVx{hESgfnCn%H}<@^CB zM(0N^{O9`jbq-szShw`ymHT0Hn}5$o%A3@cOfXFgi?6>iBZuNQ|WvOLO$(pS#GA|59N|TEiY4oxIt1epqc!J zmPC(gQ-9fO$~^+?(>@4n+rq2g`{`g#!IL?vvXDYF@1EfH$8Y!~t`+s00u|)RRKi^o z28=vPXW#?#9k}?aQ=`cu3J-Y$sPT&tR{Q`n6_Pd9rb6TccB;Gf{7687y;&OFmk? zY|9HFPw&e9_#js{9_?D5&f6>{n^2uO2Qu6(i)|&Z;YNXmmzd zM(4^rw?#yE?eKdn3&D?$PWz;q7+H$OJe9~N$7O~_Q1C!=p#9R z{*MNCtHv?m9H|wkd?(kt%P=@TuE{u)2TF<$Rt3tj2T8f$)S(NBV#JKlD?F|lTaEVU z5uCFjm7JL+A58!{kl4(>hTMF8BX(Ifs|tZWrht=*IS6DP)i1JJ5^+_cgo;4iQ35Uv z`1@nt;1NQ4!ft2WAL|0{{R3 literal 0 HcmV?d00001 diff --git a/docs/conf.py b/docs/conf.py index 58b0e01e..57e1c97c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,16 +27,9 @@ def find_version(*file_paths): return version_match.group(1) raise RuntimeError("Unable to find version string.") -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. @@ -54,9 +47,6 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' -# The encoding of source files. -#source_encoding = 'utf-8-sig' - # The master toctree document. master_doc = 'index' @@ -73,45 +63,16 @@ release = find_version("../src/attr/__init__.py") version = release.rsplit(u".", 1)[0] # The full version, including alpha/beta/rc tags. -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False +add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -119,127 +80,50 @@ pygments_style = 'sphinx' html_theme = "alabaster" -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = "_static/attrs_logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +html_static_path = ['_static'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} +html_use_smartypants = True # If false, no module index is generated. -#html_domain_indices = True +html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_use_opensearch = '' # Output file base name for HTML help builder. htmlhelp_basename = 'attrsdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - #'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'attrs.tex', u'attrs Documentation', - u'Hynek Schlawack', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples @@ -249,9 +133,6 @@ man_pages = [ [u'Hynek Schlawack'], 1) ] -# If true, show URL addresses after external links. -#man_show_urls = False - # -- Options for Texinfo output ------------------------------------------- @@ -264,20 +145,6 @@ texinfo_documents = [ 'Miscellaneous'), ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { "https://docs.python.org/3": None, } diff --git a/tox.ini b/tox.ini index 5ac85f60..fce877c1 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,7 @@ commands = coverage run --parallel -m pytest {posargs} [testenv:flake8] basepython = python3.5 deps = flake8 -commands = flake8 src tests setup.py +commands = flake8 src tests setup.py docs/conf.py [testenv:docs]