From 8764c085c4f56aef7dbeb2676b0011e70401929b Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Sat, 4 Jul 2015 18:27:32 +0200 Subject: [PATCH] Moved logo to static --- docs/_static/logo.png | Bin 0 -> 6134 bytes docs/conf.py | 114 +++++++++++++++++++++--------------------- docs/index.rst | 4 +- 3 files changed, 60 insertions(+), 58 deletions(-) create mode 100644 docs/_static/logo.png diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..3e2613acfbd728eac46391ab4a645a58f23f36e7 GIT binary patch literal 6134 zcmYjVcQ{+$|G$Y4TWUpZRccdI?L8`LR&9||yJpoMiBWA)RipMSrFPBIkXC8!QPh^! zCpIx_^UL?Y-*caH&w0*s&VAnd^}6quCPsR6)a=v%0MO~*(>5c`Xwt}~q#(UpL`p#LHQg0{}cm zUt7aGcxEdv6a$>5%$I;jRkaH(g zfs2(H3x&CKVCE)Ll9WG1@`Mbnkm_=LynHwLP+%(kd;S+C9}RC0G5bsD-89rVi7$`s10VWU+p;Jd^RG=?Td;ZN?grU!aEa}c z68}=7&Pua@dYl}~(zhm?dXGEHWVyeP;I?Z=-L1aS7R4P}8)laI>7^gfTF=GpsM9)Eb0Xc+2FchpT?|CY7owf zI1JkMWH=LPgs?r&dx@*q;&X@tP*PWL*@bc$rc8`tUj+NJAvK0zhfZJ;G&xyYB%~H? zh#ABT&H&{}C!OHep6ZK8NIt}SAG^9MQjldjbNN=43*e;RtoUkrG@rWB_5O8Y77zHt zxL;yE^gU7M_ixPg$|9p%$z;zU`d33dmK`i^ElZMn1Cx7Lw_Etr zP~O3#Vgl}A2b>N%3Ec)VCW_W`UitmOeK9~Yp=YJJU&P@KJK%W*AMP}7Wt{vEo8A-dDsd39ezC<65= z$@(kFtv?97vafXw19>gmu9LanydU4axyTee_oyqGs?y+7( z+u~7ijI_%!Z`$u&wsAji_BJL;%!hs8g$M|!Q`ylpHY>CM&grIlG@@8fk+Qs%2B{dB zgH9g(_GbA{N;VFJLK79RQ%BS}Q%DCwx2~k6x=o`#YP!=U@=(ob1=33aVHJM!FJqHasjLjDDf)FqS5mv3OG3j3>wcQ!vS2puiMC91!m3E4Lg}JrU*s!38fSNHoop=i&=5R;H>hdNMo(Ps%!Q z8wzH$#*Ox1)#Nr)C#|OulI)wP`2q;%{ih?6TEcoO>R_PiPuOU&jQ}o%ekQVnY`I`Y zdjKlW2m8C4+emofKh|OcwAM`+*Im27!18d~*~!~d0q=Cj%KZ_jCSYpz)1G?=e6Z&5 z5q5h~_vzR=26p#9{8UImb^zMZZi;hh>~WIp&{1)vc;ls*ax!}nn?yZ%bR0dfZq)tb zp#iY8^CLshcIeX6Ewb$f)C@IjZh%J0D9_rEqBDO&uI%ONCTHWLcQyg&M;Ymtqh|X& zS_vlffsif_5W0HlM{34!3oYP3@=kIRj7}04ZDP6VvZVx|vaOfZX8+4+yIB89Dj<~D z$s?|dfwjxlokqF~;GWYn<1ED+uWH9a$4692l{3^GsOxZ!pb;-v>>vl#*~e_~b^4GOqT8Z>eSYn57e;)?c2bBeRf*3 zfIA@7@--=MAsPt&N?=ElVJ(e;sT#|x#b_WCSs9i||J~i-=@@`&_VVg(t&8hkdO*7Q zK#WtXiq47TfNFN21OB;n-qGnKd(LByp)~wc&&$V38O}k^^4xWFRZKY$pJ{_D;*NQ& z2khXC_$C_w#qsvsAY*uOMiXeA7*m-G6jOUDZ9BMycgJzFrq3)0X99Nf)TB=}S+3@1 z3>zB=fDYQ6!uVT#Zc99IzwJhY(HF;EIampeF)w}drk{a*0HcvX`Tiz;gJ$Xp1AgKF zI-9@PO|`X^@yOhR3wLw_j+h!{Wkj3w!7*xgZtq8NAr$&QC6CwIf~T?NX2G=f7D5LIy8*leezvRgf(T09{ln!eco; z%wWnP8G(!>Q-@1tgOs-lO$$VO;_B(MjD-l^>iiO^+w2I1Z_Y5GyqAOI`#c9&Hw}R^ z13kJVCAOe=8BeFI^HvC?cky>hg!XG1O<_sl>RF3}l5cGtYvoA}yI8l6sRD)XiyC~N zcCU#qCddVSVa`-PrpGJ7O<{P*f~P-BpOtnWrd?x~%28-RZ$S{g^Hc9`x>RGGx0~QK!mf zZoO@>%Or&QE?5;>1uSTE^F>0O{kOpx6Z~zKB%Ntmr%nANPmqmXlYl&hZ`O*BC2x&h zKHft+2KB5E!7>*h$oh>SG4lc89@A3QvM3s2FT9vim_mevs8>Ne6uE!B(=@ zuO9{Y;QN;#+Mh!0f!tZ0DNf5|;rxTg&*WF{QRe<_WwIU7YHMIcMY6hVRz^r7N(+N# z0>2*>16JFu{4!|Crn;NQHWUL_ABZ|jW3RJVfW+&H(lHv@*_g+@U7J@D({sV>rr%QA zRsky5HuRH8R+pn)@ON0wpx9pOy+uoBlkSNQ_{4wM`L&NRB%-1zcXVjs>GiKKYq8oWW5XsveLd3IQ& z)(j{wn-?32Zqi_88`vCTh7Pbl#)z=CU57SWF-RUwnB%YLA)u{i2cx$Tc71$!@faD9IM`O8 z03g(*SkA(>+}-(h|D7ej+xx+z zl)-d&H(w(}#*hL@N}-UuTifJMlG-Me8J|hkN{YDpmHbrLmw~F2y^E0@kMloW9ievN z?)s(3a+W26Av}S!{W)7&_Sa{f?MGGxF!yrUr?TuI9yd~;%S7jPw zulb-+^8bolZStO&9#VsqYKniwXZm`oATzK0c?xm36?m z5{D|M?ydZuyX8D~O=nw&t5sG;g@)6*Hs)gn2n~u&!tfORC6{B;$Da|RWtTCEIc~g* zBmu0(1qQo%gH(&M$~TY~O|}2!evxZj+uO^UeNQT9iHfK;&Z#e74a2O7j@A7m zEbxwp}BFRmN6)@G$Q^T2D~m3%pS^=-tI=d z6U(|nBw6SE_3IsdKq1sO0DNI0JZ0fj+W*i0!X}#f2{u};slw39<3Y~Mc-jA3=9;=! z{q=By2SGH$;qv*zB!(N^$9;Kb(pMlDH_0D}%rTRR;z7wuF|U?{9LeqEnDn)a?AGwZ zif3-ZjDZqO;T6k-pK?~8a<+=nAe#3f9WOt51nSuf5lc+Vm30e1>eBl}?d~-LH{Lpq z0y;>Dkr3ey3wscq$Y3ueDue@)1)y%>hs#TLW0%1U9u+FE^e5i}imgG3^rc@)lz>ex z#EDf_UuaRW-CP$U=cKwQO(Sb@JFyK-<@->Ga5S^&KXjggi|EmV158@ND;XzVQRY3P z1)lmNphSk!FR~{|YcR7(g_~)6sV04ACeT~@`RE5=zDSeh6_@e;E6;}h>M4fUPB$7DvYr{wF!1VzGo z{hZCoaPfcbjhTx;u%)qCTh^D}f&?w$Aad^CSBuP)^$&Tq4}lQ`v?%QdS=29{tLDZ% zlRoF7w5uwCI7HL%&CaLkWdc5g0GWSkE(E&et$Wvc7Vz_=R4HwjN&B?^-)MmdB_Z`l zT1p=F7lwK}L^R<24lyrYvlpV`^K`4-09yjw>)beL^Qy~POiuf(#;Um#bp6viU>2%r zSCyW3DRg&Z4R@p|ytwXu%Q5^aPyGeIspW)XQ*d5!|A~AzE!TBQKS7Z#10FoTigi!C zS%>3i8N~;k$s|V8sSCp(9$)C8f_cCHD`RZ+5hCylkK}7#v?`_T2`%lv|3XHh{vuuH z4xk?og-*5bu%@o|F zpIS`c&$i#7qm=#iS`Ru;UApPZTd|-K*ZO&~M^t{=h;t+_rGj?fK_;`4GrfnvY##kV z?{LKv%#isCalLI8b!lgA)s~9xKd2&;mxcXhAv-CJ@h#fca?o;DVGfDDlvO>XIL3X)$O;baZsC=3{_3B#`~(q|9PxGQa$898VxbihNV6q>mdcF^-%cyi4-Zp2B_+pH4>x;Y7R+TwXl;ScZJhwE)ZxPdRsh%C8jLbHIA zcjbqhgePA7pamIf`;z#rej)QnZnRIl8FFS&ERzNCnMK4Kz(ufpC#*^j7{4F96Uqwa zvw7o9w z%#4FOFWm!Pj9zJ_YS5OR+owBaypJZbP^Jjh{j)udcu^w2`)9t&i01ZNh(=^hJoO-l z(t`)Q@_x;dLBa<~B1+ig{kbJ<>>sHOt=O&UXBH^>LBmBj%42 znC~=A%w9i#$(8gYeKY5WPw26|&l0g)xX;1NrQ){u>j^1u>+1=wjAPIAUmcDoBFAbQ zbJ>4L8oEtCPJ~iuGMljtNR0IlJwee`Cm+h71AM9taNRwH$lqPVgG@bMX0)d!pNd*i z_bO9#+pt=qX$^+2{A7~7T+80H)~;>|pzn`vKXzv?pPlU=(V{FB3oLuAjDdAwc27$R zV$CEri*^(4fI&td1s^%_YU_Pka8ZAW{Szw!JOeA%csY z($6~GU`VEC+tX`&`s>TntNPO7diI&?!3biQYn)mBL+2kpBg79BnzR)MiQGE{u3tm! ziOH#@0l5^_5nihqEjK_!jqP5_Fk2$JUR?_=fJBny*d& zpewO{8@N(SqV#28baSqXlhtl>?PPOxk}8d?Z@yupb;E8CX!wrMk>JXEsK11iX_Tx4 z%+W5cIatWJe0w$LG~$E$i(VG>y64TTf*Y4DW7{i-Ry26Y(~^ENzHQ@xD(-Nwfgv%6 zT=Rfbh10Zt-m~C_2f9^G1eV7XFwrF}Dq{tQHkNUM!amxL!@rZJ8IP4jxtP4kG_lQe zBZ36K=S{FKs|HW~>G*iF%Z^tXG-zA2LQxt=T4rg1Ua1#(y3lF7O_ijEz%ym8^vkjY zwIByQ{WCf8Xx3ME7!YeGoP|I^2P?Xf&^)7h2GR`Xo% z;3^Gy2M~!p#~ln$JP>HLRqHmuxgnoQ8OVJk73C;IDBR9m>>3EOx6Gef*V_OUl(cx> zy`FS--M1dpV^dMmNZW;L;1|ua2n1f0SK^85k+(i4yO23l;NCQtV))ccD>@m2^~rc8 z9$g}vq&wel#b=(zdT&UYn(C^J1jgvw1nFl+xeE~{pQm`)qik-e=>0u~?vSCn@{PJb z7XH=}{;iq!-=N6;#RVFU2>DcW*ntYa3UcbP(CQ^3tEAqXnO?qertocRo*mx)x*q&F z!?)$#$@C3zmeaMvsW{oB6BSFXexk1J#&{GpK zJ~>?l`vKZgJMXmmYEW^Lrm)(kk@7|-bj{fdxi=dctPjB=r~jjgv2nmLb>g zj+=`9It=~NzQCCOwU4P&D9!)qOW>5-*#n`1?~gsh`1=@k_^X+?Y8-mycJL;By`*NG zq8P;V5?FJP($cz?eQv!(>d*uFI!4+xnyBdi1G2t^c>n+a literal 0 HcmV?d00001 diff --git a/docs/conf.py b/docs/conf.py index bbb83ef..ed9256e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ import sys import os -import shlex + import alabaster myPath = os.path.dirname(os.path.abspath(__file__)) @@ -25,12 +25,12 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'django_q.tests.settings' # 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('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# 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 @@ -38,7 +38,7 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'django_q.tests.settings' extensions = [ 'alabaster', 'sphinx.ext.todo', - #'sphinx.ext.autodoc' + # 'sphinx.ext.autodoc' ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,7 +49,7 @@ templates_path = ['_templates'] source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -77,9 +77,9 @@ language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -87,27 +87,27 @@ exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# 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 +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # 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 = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True @@ -128,6 +128,7 @@ html_theme_options = { 'github_user': 'Koed00', 'github_repo': 'django-q', 'gittip_user': 'koed00', + 'gratipay_user': 'koed00', 'github_banner': True, 'travis_button': True, } @@ -135,7 +136,7 @@ html_sidebars = { '**': [ 'about.html', 'navigation.html', - 'relations.html', + 'relations.html', 'searchbox.html', 'donate.html', ] @@ -146,14 +147,14 @@ html_theme_path = [alabaster.get_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# 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 = None # 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 @@ -163,67 +164,67 @@ html_favicon = 'favicon.ico' # 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'] +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 = [] +# 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_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # 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 = True # 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 = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'DjangoQdoc' @@ -231,25 +232,25 @@ htmlhelp_basename = 'DjangoQdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', -# Latex figure (float) alignment -#'figure_align': 'htbp', + # Latex figure (float) alignment + # 'figure_align': 'htbp', } # 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 = [ - (master_doc, 'DjangoQ.tex', 'Django Q Documentation', - 'Ilan Steemers', 'manual'), + (master_doc, 'DjangoQ.tex', 'Django Q Documentation', + 'Ilan Steemers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -258,19 +259,19 @@ latex_logo = 'logo.png' # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -282,8 +283,9 @@ man_pages = [ [author], 1) ] + # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -292,19 +294,19 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'DjangoQ', 'Django Q Documentation', - author, 'DjangoQ', 'One line description of project.', - 'Miscellaneous'), + (master_doc, 'DjangoQ', 'Django Q Documentation', + author, 'DjangoQ', 'One line description of project.', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# 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' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/docs/index.rst b/docs/index.rst index 180cc1d..3b547a0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Django Q's documentation! -==================================== +Welcome to Django Q +=================== Django Q is a native Django task queue and worker application using Python multiprocessing.