diff --git a/.gitignore b/.gitignore index 7981d1837..76ac05298 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,8 @@ docs/_build # Ignore .hgignore for contributors using Mercurial. .hgignore + +# Ignore files generated during build +build/ + +venv/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..d3375de72 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,8 @@ +sudo: false +language: python +python: + - "3.6" +install: pip install sphinx +script: + - make doctest + - make html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..9b170d2fb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +Be cordial or be on your way. + +https://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..fb3abe19b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +How to contribute +----------------- + +This guide is under heavy development. If you would like to contribute, please +see: + +https://docs.python-guide.org/notes/contribute/ + +How to test your changes +------------------------ + +The html version of this guide is built with [sphinx](http://www.sphinx-doc.org/en/stable/). You may test your revisions locally by having sphinx installed. You can do this easily with pip (as described in the link). + +``` bash +pip install --user sphinx +``` + +Then navigate to the directory of the Makefile and ```make build``` or ```make html```. Sphinx will then generate the HTML in a folder called `_build/html/` + +After navigating to this folder, you can then use Python's built in web server to view your changes locally: + +``` bash +python3 -m http.server +``` + +By default, `http.server` listens on every IP address bound on your host on port 8000. To bind to a specific one, say, localhost on port 8005: + +``` bash +python3 -m http.server 8005 --bind 127.0.0.1 +``` + +Style Guide +----------- + +For all contributions, please follow the `Guide Style Guide`: + +https://docs.python-guide.org/notes/styleguide/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..a632f3e73 --- /dev/null +++ b/LICENSE @@ -0,0 +1,360 @@ +Creative Commons Legal Code + +Attribution-NonCommercial-ShareAlike 3.0 Unported + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR + DAMAGES RESULTING FROM ITS USE. + +License + +THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE +COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY +COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS +AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. + +BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE +TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY +BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS +CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND +CONDITIONS. + +1. Definitions + + a. "Adaptation" means a work based upon the Work, or upon the Work and + other pre-existing works, such as a translation, adaptation, + derivative work, arrangement of music or other alterations of a + literary or artistic work, or phonogram or performance and includes + cinematographic adaptations or any other form in which the Work may be + recast, transformed, or adapted including in any form recognizably + derived from the original, except that a work that constitutes a + Collection will not be considered an Adaptation for the purpose of + this License. For the avoidance of doubt, where the Work is a musical + work, performance or phonogram, the synchronization of the Work in + timed-relation with a moving image ("synching") will be considered an + Adaptation for the purpose of this License. + b. "Collection" means a collection of literary or artistic works, such as + encyclopedias and anthologies, or performances, phonograms or + broadcasts, or other works or subject matter other than works listed + in Section 1(g) below, which, by reason of the selection and + arrangement of their contents, constitute intellectual creations, in + which the Work is included in its entirety in unmodified form along + with one or more other contributions, each constituting separate and + independent works in themselves, which together are assembled into a + collective whole. A work that constitutes a Collection will not be + considered an Adaptation (as defined above) for the purposes of this + License. + c. "Distribute" means to make available to the public the original and + copies of the Work or Adaptation, as appropriate, through sale or + other transfer of ownership. + d. "License Elements" means the following high-level license attributes + as selected by Licensor and indicated in the title of this License: + Attribution, Noncommercial, ShareAlike. + e. "Licensor" means the individual, individuals, entity or entities that + offer(s) the Work under the terms of this License. + f. "Original Author" means, in the case of a literary or artistic work, + the individual, individuals, entity or entities who created the Work + or if no individual or entity can be identified, the publisher; and in + addition (i) in the case of a performance the actors, singers, + musicians, dancers, and other persons who act, sing, deliver, declaim, + play in, interpret or otherwise perform literary or artistic works or + expressions of folklore; (ii) in the case of a phonogram the producer + being the person or legal entity who first fixes the sounds of a + performance or other sounds; and, (iii) in the case of broadcasts, the + organization that transmits the broadcast. + g. "Work" means the literary and/or artistic work offered under the terms + of this License including without limitation any production in the + literary, scientific and artistic domain, whatever may be the mode or + form of its expression including digital form, such as a book, + pamphlet and other writing; a lecture, address, sermon or other work + of the same nature; a dramatic or dramatico-musical work; a + choreographic work or entertainment in dumb show; a musical + composition with or without words; a cinematographic work to which are + assimilated works expressed by a process analogous to cinematography; + a work of drawing, painting, architecture, sculpture, engraving or + lithography; a photographic work to which are assimilated works + expressed by a process analogous to photography; a work of applied + art; an illustration, map, plan, sketch or three-dimensional work + relative to geography, topography, architecture or science; a + performance; a broadcast; a phonogram; a compilation of data to the + extent it is protected as a copyrightable work; or a work performed by + a variety or circus performer to the extent it is not otherwise + considered a literary or artistic work. + h. "You" means an individual or entity exercising rights under this + License who has not previously violated the terms of this License with + respect to the Work, or who has received express permission from the + Licensor to exercise rights under this License despite a previous + violation. + i. "Publicly Perform" means to perform public recitations of the Work and + to communicate to the public those public recitations, by any means or + process, including by wire or wireless means or public digital + performances; to make available to the public Works in such a way that + members of the public may access these Works from a place and at a + place individually chosen by them; to perform the Work to the public + by any means or process and the communication to the public of the + performances of the Work, including by public digital performance; to + broadcast and rebroadcast the Work by any means including signs, + sounds or images. + j. "Reproduce" means to make copies of the Work by any means including + without limitation by sound or visual recordings and the right of + fixation and reproducing fixations of the Work, including storage of a + protected performance or phonogram in digital form or other electronic + medium. + +2. Fair Dealing Rights. Nothing in this License is intended to reduce, +limit, or restrict any uses free from copyright or rights arising from +limitations or exceptions that are provided for in connection with the +copyright protection under copyright law or other applicable laws. + +3. License Grant. Subject to the terms and conditions of this License, +Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +perpetual (for the duration of the applicable copyright) license to +exercise the rights in the Work as stated below: + + a. to Reproduce the Work, to incorporate the Work into one or more + Collections, and to Reproduce the Work as incorporated in the + Collections; + b. to create and Reproduce Adaptations provided that any such Adaptation, + including any translation in any medium, takes reasonable steps to + clearly label, demarcate or otherwise identify that changes were made + to the original Work. For example, a translation could be marked "The + original work was translated from English to Spanish," or a + modification could indicate "The original work has been modified."; + c. to Distribute and Publicly Perform the Work including as incorporated + in Collections; and, + d. to Distribute and Publicly Perform Adaptations. + +The above rights may be exercised in all media and formats whether now +known or hereafter devised. The above rights include the right to make +such modifications as are technically necessary to exercise the rights in +other media and formats. Subject to Section 8(f), all rights not expressly +granted by Licensor are hereby reserved, including but not limited to the +rights described in Section 4(e). + +4. Restrictions. The license granted in Section 3 above is expressly made +subject to and limited by the following restrictions: + + a. You may Distribute or Publicly Perform the Work only under the terms + of this License. You must include a copy of, or the Uniform Resource + Identifier (URI) for, this License with every copy of the Work You + Distribute or Publicly Perform. You may not offer or impose any terms + on the Work that restrict the terms of this License or the ability of + the recipient of the Work to exercise the rights granted to that + recipient under the terms of the License. You may not sublicense the + Work. You must keep intact all notices that refer to this License and + to the disclaimer of warranties with every copy of the Work You + Distribute or Publicly Perform. When You Distribute or Publicly + Perform the Work, You may not impose any effective technological + measures on the Work that restrict the ability of a recipient of the + Work from You to exercise the rights granted to that recipient under + the terms of the License. This Section 4(a) applies to the Work as + incorporated in a Collection, but this does not require the Collection + apart from the Work itself to be made subject to the terms of this + License. If You create a Collection, upon notice from any Licensor You + must, to the extent practicable, remove from the Collection any credit + as required by Section 4(d), as requested. If You create an + Adaptation, upon notice from any Licensor You must, to the extent + practicable, remove from the Adaptation any credit as required by + Section 4(d), as requested. + b. You may Distribute or Publicly Perform an Adaptation only under: (i) + the terms of this License; (ii) a later version of this License with + the same License Elements as this License; (iii) a Creative Commons + jurisdiction license (either this or a later license version) that + contains the same License Elements as this License (e.g., + Attribution-NonCommercial-ShareAlike 3.0 US) ("Applicable License"). + You must include a copy of, or the URI, for Applicable License with + every copy of each Adaptation You Distribute or Publicly Perform. You + may not offer or impose any terms on the Adaptation that restrict the + terms of the Applicable License or the ability of the recipient of the + Adaptation to exercise the rights granted to that recipient under the + terms of the Applicable License. You must keep intact all notices that + refer to the Applicable License and to the disclaimer of warranties + with every copy of the Work as included in the Adaptation You + Distribute or Publicly Perform. When You Distribute or Publicly + Perform the Adaptation, You may not impose any effective technological + measures on the Adaptation that restrict the ability of a recipient of + the Adaptation from You to exercise the rights granted to that + recipient under the terms of the Applicable License. This Section 4(b) + applies to the Adaptation as incorporated in a Collection, but this + does not require the Collection apart from the Adaptation itself to be + made subject to the terms of the Applicable License. + c. You may not exercise any of the rights granted to You in Section 3 + above in any manner that is primarily intended for or directed toward + commercial advantage or private monetary compensation. The exchange of + the Work for other copyrighted works by means of digital file-sharing + or otherwise shall not be considered to be intended for or directed + toward commercial advantage or private monetary compensation, provided + there is no payment of any monetary compensation in con-nection with + the exchange of copyrighted works. + d. If You Distribute, or Publicly Perform the Work or any Adaptations or + Collections, You must, unless a request has been made pursuant to + Section 4(a), keep intact all copyright notices for the Work and + provide, reasonable to the medium or means You are utilizing: (i) the + name of the Original Author (or pseudonym, if applicable) if supplied, + and/or if the Original Author and/or Licensor designate another party + or parties (e.g., a sponsor institute, publishing entity, journal) for + attribution ("Attribution Parties") in Licensor's copyright notice, + terms of service or by other reasonable means, the name of such party + or parties; (ii) the title of the Work if supplied; (iii) to the + extent reasonably practicable, the URI, if any, that Licensor + specifies to be associated with the Work, unless such URI does not + refer to the copyright notice or licensing information for the Work; + and, (iv) consistent with Section 3(b), in the case of an Adaptation, + a credit identifying the use of the Work in the Adaptation (e.g., + "French translation of the Work by Original Author," or "Screenplay + based on original Work by Original Author"). The credit required by + this Section 4(d) may be implemented in any reasonable manner; + provided, however, that in the case of a Adaptation or Collection, at + a minimum such credit will appear, if a credit for all contributing + authors of the Adaptation or Collection appears, then as part of these + credits and in a manner at least as prominent as the credits for the + other contributing authors. For the avoidance of doubt, You may only + use the credit required by this Section for the purpose of attribution + in the manner set out above and, by exercising Your rights under this + License, You may not implicitly or explicitly assert or imply any + connection with, sponsorship or endorsement by the Original Author, + Licensor and/or Attribution Parties, as appropriate, of You or Your + use of the Work, without the separate, express prior written + permission of the Original Author, Licensor and/or Attribution + Parties. + e. For the avoidance of doubt: + + i. Non-waivable Compulsory License Schemes. In those jurisdictions in + which the right to collect royalties through any statutory or + compulsory licensing scheme cannot be waived, the Licensor + reserves the exclusive right to collect such royalties for any + exercise by You of the rights granted under this License; + ii. Waivable Compulsory License Schemes. In those jurisdictions in + which the right to collect royalties through any statutory or + compulsory licensing scheme can be waived, the Licensor reserves + the exclusive right to collect such royalties for any exercise by + You of the rights granted under this License if Your exercise of + such rights is for a purpose or use which is otherwise than + noncommercial as permitted under Section 4(c) and otherwise waives + the right to collect royalties through any statutory or compulsory + licensing scheme; and, + iii. Voluntary License Schemes. The Licensor reserves the right to + collect royalties, whether individually or, in the event that the + Licensor is a member of a collecting society that administers + voluntary licensing schemes, via that society, from any exercise + by You of the rights granted under this License that is for a + purpose or use which is otherwise than noncommercial as permitted + under Section 4(c). + f. Except as otherwise agreed in writing by the Licensor or as may be + otherwise permitted by applicable law, if You Reproduce, Distribute or + Publicly Perform the Work either by itself or as part of any + Adaptations or Collections, You must not distort, mutilate, modify or + take other derogatory action in relation to the Work which would be + prejudicial to the Original Author's honor or reputation. Licensor + agrees that in those jurisdictions (e.g. Japan), in which any exercise + of the right granted in Section 3(b) of this License (the right to + make Adaptations) would be deemed to be a distortion, mutilation, + modification or other derogatory action prejudicial to the Original + Author's honor and reputation, the Licensor will waive or not assert, + as appropriate, this Section, to the fullest extent permitted by the + applicable national law, to enable You to reasonably exercise Your + right under Section 3(b) of this License (right to make Adaptations) + but not otherwise. + +5. Representations, Warranties and Disclaimer + +UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING AND TO THE +FULLEST EXTENT PERMITTED BY APPLICABLE LAW, LICENSOR OFFERS THE WORK AS-IS +AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE +WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT +LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, +ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT +DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED +WARRANTIES, SO THIS EXCLUSION MAY NOT APPLY TO YOU. + +6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE +LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR +ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES +ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS +BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +7. Termination + + a. This License and the rights granted hereunder will terminate + automatically upon any breach by You of the terms of this License. + Individuals or entities who have received Adaptations or Collections + from You under this License, however, will not have their licenses + terminated provided such individuals or entities remain in full + compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will + survive any termination of this License. + b. Subject to the above terms and conditions, the license granted here is + perpetual (for the duration of the applicable copyright in the Work). + Notwithstanding the above, Licensor reserves the right to release the + Work under different license terms or to stop distributing the Work at + any time; provided, however that any such election will not serve to + withdraw this License (or any other license that has been, or is + required to be, granted under the terms of this License), and this + License will continue in full force and effect unless terminated as + stated above. + +8. Miscellaneous + + a. Each time You Distribute or Publicly Perform the Work or a Collection, + the Licensor offers to the recipient a license to the Work on the same + terms and conditions as the license granted to You under this License. + b. Each time You Distribute or Publicly Perform an Adaptation, Licensor + offers to the recipient a license to the original Work on the same + terms and conditions as the license granted to You under this License. + c. If any provision of this License is invalid or unenforceable under + applicable law, it shall not affect the validity or enforceability of + the remainder of the terms of this License, and without further action + by the parties to this agreement, such provision shall be reformed to + the minimum extent necessary to make such provision valid and + enforceable. + d. No term or provision of this License shall be deemed waived and no + breach consented to unless such waiver or consent shall be in writing + and signed by the party to be charged with such waiver or consent. + e. This License constitutes the entire agreement between the parties with + respect to the Work licensed here. There are no understandings, + agreements or representations with respect to the Work not specified + here. Licensor shall not be bound by any additional provisions that + may appear in any communication from You. This License may not be + modified without the mutual written agreement of the Licensor and You. + f. The rights granted under, and the subject matter referenced, in this + License were drafted utilizing the terminology of the Berne Convention + for the Protection of Literary and Artistic Works (as amended on + September 28, 1979), the Rome Convention of 1961, the WIPO Copyright + Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 + and the Universal Copyright Convention (as revised on July 24, 1971). + These rights and subject matter take effect in the relevant + jurisdiction in which the License terms are sought to be enforced + according to the corresponding provisions of the implementation of + those treaty provisions in the applicable national law. If the + standard suite of rights granted under applicable copyright law + includes additional rights not granted under this License, such + additional rights are deemed to be included in the License; this + License is not intended to restrict the license of any rights under + applicable law. + + +Creative Commons Notice + + Creative Commons is not a party to this License, and makes no warranty + whatsoever in connection with the Work. Creative Commons will not be + liable to You or any party on any legal theory for any damages + whatsoever, including without limitation any general, special, + incidental or consequential damages arising in connection to this + license. Notwithstanding the foregoing two (2) sentences, if Creative + Commons has expressly identified itself as the Licensor hereunder, it + shall have all rights and obligations of Licensor. + + Except for the limited purpose of indicating to the public that the + Work is licensed under the CCPL, Creative Commons does not authorize + the use by either party of the trademark "Creative Commons" or any + related trademark or logo of Creative Commons without the prior + written consent of Creative Commons. Any permitted use will be in + compliance with Creative Commons' then-current trademark usage + guidelines, as may be published on its website or otherwise made + available upon request from time to time. For the avoidance of doubt, + this trademark restriction does not form part of this License. + + Creative Commons may be contacted at http://creativecommons.org/. diff --git a/Makefile b/Makefile index 4c2b0cf39..e702e7819 100644 --- a/Makefile +++ b/Makefile @@ -1,2 +1,7 @@ -build: - cd docs && make html \ No newline at end of file +.PHONY: build +build: html + +# this pattern rule lets you run "make build" (or any other target +# in docs/Makefile) in this directory as though you were in docs/ +%: + cd docs && make $@ diff --git a/Readme.rst b/Readme.rst index 7d3237804..f35c71225 100644 --- a/Readme.rst +++ b/Readme.rst @@ -3,24 +3,36 @@ Hitchhiker's Guide to Python **Python Best Practices Guidebook** +→ Read the free guide at: `docs.python-guide.org `_ + +.. image:: https://farm1.staticflickr.com/628/33173824932_58add34581_k_d.jpg + ----------- -**Work in progress. If you'd like to help, please do. There's a lot of work to be done.** +**Work in progress. If you'd like to help, please do. There's a lot of work to +be done.** -This guide is currently under heavy development. This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis. +This guide is currently under heavy development. This opinionated guide +exists to provide both novice and expert Python developers a best practice +handbook to the installation, configuration, and usage of Python on a daily +basis. Topics include: -- Platform/version specific installations +- Platform and version-specific installations - Py2app, Py2exe, bbfreeze, pyInstaller -- Pip / virtualenv -- Documentation. Writing it. -- server configurations / tools for various web frameworks -- fabric -- exhaustive module recommendations, grouped by topic/purpose -- Testing. Jenkins + tox guides. -- How to interface w/ hg from git easily -- what libraries to use for what - - +- Pip +- Numpy, scipy, statpy, pyplot, matplotlib +- Virtualenv +- Fabric +- Exhaustive module recommendations, grouped by topic/purpose +- Which libraries to use for what +- Server configurations & tools for various web frameworks +- Documentation: writing it +- Testing: Jenkins & tox guides +- How to easily interface ``hg`` from ``git`` + +If you aren't fond of reading reStructuredText, there is an +almost up-to-date `HTML version at docs.python-guide.org +`_. diff --git a/docs/404.rst b/docs/404.rst new file mode 100644 index 000000000..f4fc9fcc1 --- /dev/null +++ b/docs/404.rst @@ -0,0 +1,28 @@ +:orphan: + +################# +404 — Not Found +################# + +**Sorry, but we couldn't find the page you requested.** + +It looks like this was the result of either: + +- a mistyped address +- an out-of-date link + +`Click here to go back to the homepage. `_ + +Or, try `searching `_. + +.. raw:: html + + diff --git a/docs/Makefile b/docs/Makefile index d8dd1f433..963704aff 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -7,12 +7,19 @@ SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf latexpdfja text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @@ -27,14 +34,20 @@ help: @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: - -rm -rf $(BUILDDIR)/* + rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @@ -46,6 +59,12 @@ dirhtml: @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." +netlify: dirhtml + @cp $(BUILDDIR)/dirhtml/404/index.html $(BUILDDIR)/dirhtml/404.html + @sed -i -e 's/src="..\//src="\//g' $(BUILDDIR)/dirhtml/404.html + @sed -i -e 's/href="..\//href="\//g' $(BUILDDIR)/dirhtml/404.html + @cp _extra/* $(BUILDDIR)/dirhtml/ + singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @@ -72,17 +91,17 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/osxpython.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pythonguide.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/osxpython.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pythonguide.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/osxpython" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/osxpython" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pythonguide" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pythonguide" @echo "# devhelp" epub: @@ -100,7 +119,13 @@ latex: latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: @@ -113,6 +138,24 @@ man: @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @@ -128,3 +171,16 @@ doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +serve: + cd $(BUILDDIR)/dirhtml && python3 -m http.server 8005 diff --git a/docs/_extra/_redirects b/docs/_extra/_redirects new file mode 100644 index 000000000..2cb986392 --- /dev/null +++ b/docs/_extra/_redirects @@ -0,0 +1,18 @@ +# Redirect rules +# Docs: https://www.netlify.com/docs/redirects/ + +# Redirect http to https (avoid one extra hop with an explicit rule for /en/latest/) +http://docs.python-guide.org/en/latest/* https://docs.python-guide.org/:splat 301! +http://docs.python-guide.org/* https://docs.python-guide.org/:splat 301! + +# Redirect RTD prefix to / +/en/latest/* /:splat 301! + +# Redirect domain aliases to primary domain +http://python-guide.org/* http://docs.python-guide.org/:splat 301! +https://python-guide.org/* https://docs.python-guide.org/:splat 301! + +# Redirect Netlify version to primary domain +https://python-guide.netlify.com/* https://docs.python-guide.org/:splat 301! + +/guide-book https://www.amazon.com/Hitchhikers-Guide-Python-Practices-Development/dp/1491933178/ref=as_li_ss_il?ie=UTF8&linkCode=li2&tag=bookforkind-20&linkId=804806ebdacaf3b56567347f3afbdbca 302 diff --git a/docs/_extra/ads.txt b/docs/_extra/ads.txt new file mode 100644 index 000000000..52291a930 --- /dev/null +++ b/docs/_extra/ads.txt @@ -0,0 +1,340 @@ +33across.com, 0010b00002Mpn7AAAR, DIRECT, bbea06d9c4d2853c +33across.com, 0013300001kQj2HAAS, RESELLER, bbea06d9c4d2853c +33across.com, 0013300001qkdlwAAA, RESELLER +33across.com, 0013300001r0t9mAAA, RESELLER +33across.com, 0014000001aXjnGAAS, RESELLER, bbea06d9c4d2853c # 33 Across +33across.com,0013300001r0t9mAAA,reseller,bbea06d9c4d2853c +ad-generation.jp,12474,RESELLER,7f4ea9029ac04e53 +adform.com, 183, RESELLER +adform.com, 2708, DIRECT, 9f5210a2f0999e32 +adtech.com, 10947, DIRECT, e1a5b5b6e3255540 +adtech.com, 11095, RESELLER +adtech.com, 11119, RESELLER +adtech.com, 11208, RESELLER +adtech.com, 11341, DIRECT +adtech.com, 12094, RESELLER +adtech.com, 12094, RESELLER # 33 Across +adtech.com, 9904, RESELLER +adtech.com,12068,RESELLER,e1a5b5b6e3255540 +advangelists.com, 8d3bba7425e7c98c50f52ca1b52d3735, RESELLER, 60d26397ec060f98 +advangelists.com, 8d3bba7425e7c98c50f52ca1b52d3735, RESELLER, 60d26397ec060f98 # 33 Across +advertising.com, 11602, RESELLER +Advertising.com, 16736, RESELLER +advertising.com, 19623, RESELLER # AOL - One +advertising.com, 24410, RESELLER +advertising.com, 28409, DIRECT, e1a5b5b6e3255540 +advertising.com, 28509, DIRECT, e1a5b5b6e3255540 +advertising.com, 28605, RESELLER # RhythmOne +advertising.com, 7372, RESELLER +advertising.com, 8603, RESELLER # Taboola +amxrtb.com, 105199384, DIRECT +aol.com, 11119, DIRECT +aol.com, 53392, RESELLER # Taboola +aolcloud.net, 9904, RESELLER +appnexus.com, 1001, RESELLER, f5ab79cb980f11d1 +appnexus.com, 10239, RESELLER, f5ab79cb980f11d1 +appnexus.com, 10239, RESELLER, f5ab79cb980f11d1 # 33 Across +appnexus.com, 11786, RESELLER, f5ab79cb980f11d1 +appnexus.com, 11801, RESELLER +appnexus.com, 11924, RESELLER, f5ab79cb980f11d1 +appnexus.com, 12061, RESELLER +appnexus.com, 12263, RESELLER +appnexus.com, 12290, RESELLER, f5ab79cb980f11d1 +appnexus.com, 12366, RESELLER, f5ab79cb980f11d1 +appnexus.com, 1314, RESELLER +Appnexus.com, 1356, RESELLER, f5ab79cb980f11d1 +appnexus.com, 1360, RESELLER, f5ab79cb980f11d1 +appnexus.com, 1613, reseller +appnexus.com, 1908, RESELLER +appnexus.com, 1908, RESELLER, f5ab79cb980f11d1 +appnexus.com, 1908, RESELLER, f5ab79cb980f11d1 # DistrictM +appnexus.com, 1942, RESELLER, f5ab79cb980f11d1 +appnexus.com, 2530, RESELLER +appnexus.com, 2758, RESELLER, f5ab79cb980f11d1 +appnexus.com, 3135, RESELLER, f5ab79cb980f11d1 +appnexus.com, 3153, DIRECT +appnexus.com, 3153, RESELLER +appnexus.com, 3153, RESELLER, f5ab79cb980f11d1 +appnexus.com, 3326, reseller +appnexus.com, 4052, RESELLER +appnexus.com, 4052, RESELLER, f5ab79cb980f11d1 # Conversant +appnexus.com, 6849, RESELLER, f5ab79cb980f11d1 # RhythmOne +appnexus.com, 7118, RESELLER +appnexus.com, 7556, DIRECT, f5ab79cb980f11d1 +appnexus.com, 7597, RESELLER, f5ab79cb980f11d1 +appnexus.com, 7911, RESELLER #yieldmo +appnexus.com, 7944, RESELLER +appnexus.com, 8692, DIRECT, f5ab79cb980f11d1 +appnexus.com, 9316, RESELLER, f5ab79cb980f11d1 # AppNexus +appnexus.com, 9393, DIRECT +appnexus.com, 9393, RESELLER #Video #Display, f5ab79cb980f11d1 +appnexus.com,1001,reseller,f5ab79cb980f11d1 +appnexus.com,10239,reseller,f5ab79cb980f11d1 +appnexus.com,1356,reseller,f5ab79cb980f11d1 +appnexus.com,1908,RESELLER,f5ab79cb980f11d1 +appnexus.com,2758,reseller,f5ab79cb980f11d1 +appnexus.com,3663,RESELLER,f5ab79cb980f11d1 +appnexus.com,7597,reseller,f5ab79cb980f11d1 +appnexus.com,9316,reseller,f5ab79cb980f11d1 +aps.amazon.com,094e2c86-72d9-47d6-a647-d95ce39ad4c7,DIRECT +aps.amazon.com,2840f06c-5d89-4853-a03e-3bfa567dd33c,reseller +aps.amazon.com,48266a61-b3d9-4cb7-b172-553abc6a42a4,DIRECT +aralego.com, par-488A3E6BD8D997D0ED8B3BD34D8BA4B, RESELLER # ucFunnel +audienciad.com, 202922, DIRECT +bidtellect.com, 1407, RESELLER, 1c34aa2d85d45e93 +bidtellect.com,1407,reseller,1c34aa2d85d45e93 +brightcom.com, 20292, DIRECT +ccoxmt.com, 2000067997702, RESELLER +consumable.com, 2000908, DIRECT, aefcd3d2f45b5070 +contextweb.com, 558355, RESELLER +contextweb.com, 558511, RESELLER +contextweb.com, 560606, RESELLER +contextweb.com, 560606, RESELLER, 89ff185a4c4e857 +contextweb.com, 560606, RESELLER, 89ff185a4c4e857c +contextweb.com, 561118, RESELLER, 89ff185a4c4e857c #yieldmo +contextweb.com, 561998, RESELLER, 89ff185a4c4e857c +contextweb.com, 562350, RESELLER, 89ff185a4c4e857c +contextweb.com,558355,reseller +conversantmedia.com, 20923, RESELLER # Conversant +conversantmedia.com, 39882, DIRECT, 03113cd04947736d +conversantmedia.com, 40790, RESELLER, 03113cd04947736d +conversantmedia.com, 41812, DIRECT +coxmt.com, 2000067907202, RESELLER +criteo.com, 109412, DIRECT, 9fac4a4a87c2a44f +districtm.io, 100808, DIRECT +districtm.io, 100835, DIRECT +districtm.io, 100835, DIRECT, 3fd707be9c4527c3 +districtm.io, 101080, RESELLER +districtm.io, 101769, RESELLER, 3fd707be9c4527c3 # DistrictM +districtm.io,100962,RESELLER,3fd707be9c4527c3 +EMXDGT.com, 1133, DIRECT, 1e1d41537f7cad7f +emxdgt.com, 20, DIRECT, 1e1d41537f7cad7f +emxdgt.com, 326, RESELLER, 1e1d41537f7cad7f +emxdgt.com, 326, RESELLER, 1e1d41537f7cad7f # 33 Across +EMXDGT.com,1284,reseller,1e1d41537f7cad7f +engagebdr.com, 10417, RESELLER # EngageDBR +freewheel.tv, 146081, reseller +freewheel.tv, 19129, RESELLER +freewheel.tv, 19133, RESELLER +freewheel.tv, 33081, RESELLER +freewheel.tv, 33601, RESELLER +freewheel.tv, 799841, RESELLER # Taboola +freewheel.tv, 799921, RESELLER # Taboola +google.com, pub-1320774679920841, RESELLER, f08c47fec0942fa0 +google.com, pub-1409765517756851, reseller +google.com, pub-2290755540215120, RESELLER, f08c47fec0942fa0 +google.com, pub-2802445174821308, RESELLER, f08c47fec0942fa0 +google.com, pub-3848273848634341, RESELLER, f08c47fec0942fa0 +google.com, pub-4075894099602271, reseller +google.com, pub-4207323757133151, RESELLER, f08c47fec0942fa0 +google.com, pub-4641608711979091, DIRECT, f08c47fec0942fa0 +google.com, pub-5231479214411897, RESELLER, f08c47fec0942fa0 +Google.com, pub-5995202563537249, RESELLER, f08c47fec0942fa0 +google.com, pub-6314168058065736, RESELLER, f08c47fec0942fa0 +google.com, pub-8172268348509349, RESELLER, f08c47fec0942fa0 +google.com, pub-9557089510405422, RESELLER, f08c47fec0942fa0 +google.com, pub-9557089510405422, RESELLER, f08c47fec0942fa0 # 33 Across +google.com, pub-9685734445476814, RESELLER, f08c47fec0942fa0 +google.com, pub-9685734445476814, RESELLER, f08c47fec0942fa0 # DistrictM +google.com,pub-3848273848634341,reseller,f08c47fec0942fa0 +google.com,pub-9557089510405422,reseller,f08c47fec0942fa0 +gumgum.com, 11645, RESELLER, ffdef49475d318a9 +gumgum.com, 13174, DIRECT, ffdef49475d318a9 +gumgum.com, 13318, RESELLER, ffdef49475d318a9 +gumgum.com, 13318, RESELLER, ffdef49475d318a9 # 33 Across +gumgum.com, 13504, RESELLER, ffdef49475d318a9 +gumgum.com,13174,DIRECT,ffdef49475d318a9 +gumgum.com,14141,RESELLER,ffdef49475d318a9 +improvedigital.com, 1362, RESELLER +improvedigital.com, 1669, RESELLER # ImproveDigital +improvedigital.com, 185, RESELLER +indexexchange.com, 175407, RESELLER +indexexchange.com, 177754, RESELLER, 50b1c356f2c5c8fc +indexexchange.com, 182257, RESELLER, 50b1c356f2c5c8fc # RhythmOne +indexexchange.com, 183965, RESELLER, 50b1c356f2c5c8fc # AOL - One +indexexchange.com, 184914, DIRECT, 50b1c356f2c5c8fc +indexexchange.com, 186046, RESELLER +indexexchange.com, 186248, DIRECT, 50b1c356f2c5c8fc +indexexchange.com, 187196, DIRECT +indexexchange.com, 187454, DIRECT, 50b1c356f2c5c8fc +indexexchange.com, 189744, RESELLER +indexexchange.com, 189872, RESELLER +indexexchange.com, 191503, RESELLER, 50b1c356f2c5c8fc +indexexchange.com, 191740, RESELLER, 50b1c356f2c5c8fc # Index +indexexchange.com, 191923, RESELLER +indexexchange.com, 191973, RESELLER, 50b1c356f2c5c8fc +indexexchange.com, 193351, DIRECT +lijit.com, 217352, DIRECT, fafdf38b16bf6b2b +lijit.com, 217352-eb, DIRECT, fafdf38b16bf6b2b +lijit.com, 248396, DIRECT, fafdf38b16bf6b2b +lijit.com, 248396-eb, DIRECT, fafdf38b16bf6b2b +lijit.com, 260380, RESELLER, fafdf38b16bf6b2b +lijit.com, 270524, RESELLER, fafdf38b16bf6b2b +lijit.com,217352,DIRECT,fafdf38b16bf6b2b +lkqd.com, 470, RESELLER, 59c49fa9598a0117 +lkqd.net, 470, RESELLER, 59c49fa9598a0117 +Newormedia.com, 2169, DIRECT +newormedia.com, 4908, DIRECT +onetag.com, 572a470226457b8, RESELLER # OneTag +onetag.com, 664e107d9f2b748, RESELLER #yieldmo +onomagic.com, 202921, DIRECT +openx.com, 539824308, RESELLER, 6a698e2ec38604c6 +openx.com, 537120563, RESELLER, 6a698e2ec38604c6 +openx.com, 537120563, RESELLER, 6a698e2ec38604c6 # 33 Across +openx.com, 537120960, RESELLER +openx.com, 537127577, RESELLER, 6a698e2ec38604c6 +Openx.com, 537143344, RESELLER +openx.com, 537149485, RESELLER, 6a698e2ec38604c6 +openx.com, 537150004, DIRECT, 6a698e2ec38604c6 +openx.com, 537153209, RESELLER, 6a698e2ec38604c6 +openx.com, 538959099, RESELLER +openx.com, 538959099, RESELLER, 6a698e2ec38604c6 +openx.com, 539699341, DIRECT, 6a698e2ec38604c6 +openx.com, 539824308, RESELLER, 6a698e2ec38604c6 +openx.com, 540003333, RESELLER, 6a698e2ec38604c6 +openx.com, 540031703, RESELLER, 6a698e2ec38604c6 +openx.com, 540031703, RESELLER, 6a698e2ec38604c6 # Conversant +openx.com, 540258065, RESELLER, 6a698e2ec38604c6 +openx.com, 540274407, RESELLER, 6a698e2ec38604c6 +openx.com, 540337213, RESELLER, 6a698e2ec38604c6 +openx.com, 540401713, RESELLER, 6a698e2ec38604c6 # OpenX +openx.com, 541159484, RESELLER, 6a698e2ec38604c6 +openx.com, 542511596, RESELLER, 6a698e2ec38604c6 +openx.com, 83499, RESELLER +openx.com,537149485,reseller,6a698e2ec38604c6 +openx.com,540191398,RESELLER,6a698e2ec38604c6 +openx.com,540833447, RESELLER, 6a698e2ec38604c6 +outbrain.com, 01a755b08c8c22b15d46a8b753ab6955d4, DIRECT +outbrain.com, 01a755b08c8c22b15d46a8b753ab6955d4, RESELLER +outbrain.com,00254374f0c468f3b2732db17fd42cb6e5,reseller +pubmatic.com, 137711, RESELLER +pubmatic.com, 137711, RESELLER, 5d62403b186f2ace +pubmatic.com, 156084, RESELLER, 5d62403b186f2ace # AOL - One +pubmatic.com, 156212, RESELLER +pubmatic.com, 156212, RESELLER, 5d62403b186f2ace +pubmatic.com, 156307, RESELLER, 5d62403b186f2ace # Taboola +pubmatic.com, 156319, DIRECT, 5d62403b186f2ace +pubmatic.com, 156325, RESELLER, 5d62403b186f2ace # AOL - One +pubmatic.com, 156344, RESELLER, 5d62403b186f2ace # Pubmatic +pubmatic.com, 156423, RESELLER, 5d62403b186f2ace +pubmatic.com, 156423, RESELLER, 5d62403b186f2ace # 33 Across +pubmatic.com, 156458, RESELLER, 5d62403b186f2ace # AOL - One +pubmatic.com, 156557, RESELLER +pubmatic.com, 156595, RESELLER, 5d62403b186f2ace +pubmatic.com, 157367, DIRECT, 5d62403b186f2ace +pubmatic.com, 158100, RESELLER, 5d62403b186f2ace +pubmatic.com, 158355 , RESELLER, 5d62403b186f2ace +pubmatic.com, 158723, RESELLER, 5d62403b186f2ace +pubmatic.com, 159117, DIRECT, 5d62403b186f2ace +pubmatic.com, 159277, RESELLER, 5d62403b186f2ace # RhythmOne +pubmatic.com, 159330, RESELLER, 5d62403b186f2ace +pubmatic.com, 159477,RESELLER,5d62403b186f2ace +pubmatic.com, 160082 , RESELLER, 5d62403b186f2ace +pubmatic.com, 160131, RESELLER, 5d62403b186f2ace +pubmatic.com, 32987, RESELLER, 5d62403b186f2ace +pubmatic.com, 50758, RESELLER, 5d62403b186f2ace +pubmatic.com, 62483, RESELLER +pubmatic.com, 79136 , RESELLER, 5d62403b186f2ace +pubmatic.com,157150,RESELLER,5d62403b186f2ace +pubmatic.com,157897,reseller,5d62403b186f2ace +pubmatic.com,160006,RESELLER,5d62403b186f2ace +pubmatic.com,160096,RESELLER,5d62403b186f2ace +pubnative.net, 1007284, RESELLER, d641df8625486a7b #yieldmodisplay +pubnative.net, 1007285, RESELLER, d641df8625486a7b #yieldmonative +pubnative.net, 1007286, RESELLER, d641df8625486a7b #yieldmovideo +pubnx.com, 337-1, RESELLER, 8728b7e97e589da4 # Vertoz +revcontent.com, 76611, RESELLER +rhythmone.com, 1059622079, RESELLER +rhythmone.com, 1059622079, RESELLER, a670c89d4a324e47 +rhythmone.com, 1114124056, RESELLER, a670c89d4a324e47 +rhythmone.com, 1166984029, RESELLER, a670c89d4a324e47 # Taboola +rhythmone.com, 2241341073, RESELLER, a670c89d4a324e47 +rhythmone.com, 2310154583, DIRECT, a670c89d4a324e47 +rhythmone.com, 2439829435, RESELLER, a670c89d4a324e47 +rhythmone.com, 2439829435, RESELLER, a670c89d4a324e47 # 33 Across +rhythmone.com, 78519861, RESELLER +rhythmone.com, 905992537, RESELLER, a670c89d4a324e47 # RhythmOne +rhythmone.com,1654642120,RESELLER,a670c89d4a324e47 +rhythmone.com,2310154583,DIRECT,a670c89d4a324e47 +rhythmone.com,78519861,reseller,a670c89d4a324e47 +rtk.io, 819, DIRECT +rubiconproject.com, 13344, RESELLER, 0bfd66d529a55807 # Rubicon +rubiconproject.com, 15268, RESELLER, 0bfd66d529a55807 # RhythmOne +rubiconproject.com, 16414, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 16414, RESELLER, 0bfd66d529a55807 # 33 Across +rubiconproject.com, 17070, RESELLER, 0bfd66d529a55807 #yieldmo +rubiconproject.com, 17632, DIRECT, 0bfd66d529a55807 +rubiconproject.com, 17790, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 17792, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 17822, DIRECT, 0bfd66d529a55807 +rubiconproject.com, 17822, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 17960, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 18222, RESELLER, 0bfd66d529a55807 # AOL - One +rubiconproject.com, 18694, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 18890, DIRECT, 0bfd66d529a55807 +rubiconproject.com, 20130, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 20416, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 21310, RESELLER , 0bfd66d529a55807 +rubiconproject.com, 21642, RESELLER, 0bfd66d529a55807 +rubiconproject.com, 8861, reseller, 0bfd66d529a55807 +rubiconproject.com,18020,RESELLER,0bfd66d529a55807 +Sekindo.com, 20749, DIRECT, b6b21d256ef43532 +sharethrough.com, 3a0f657b, DIRECT, d53b998a7bd4ecd2 +sharethrough.com, d09156e5, RESELLER, d53b998a7bd4ecd2 +smaato.com, 1100033117, RESELLER +smaato.com, 1100047713, RESELLER, 07bcf65f187117b4 +smaato.com,1100044650,RESELLER,07bcf65f187117b4 +smartadserver.com, 3436, RESELLER +sonobi.com, 337f0e70cc, DIRECT +sonobi.com, 37dd19ad4a, RESELLER, d1a215d9eb5aee9e +sonobi.com, 6e5cfb5420, DIRECT, d1a215d9eb5aee9e +sonobi.com, e55fb5d7c2, DIRECT, d1a215d9eb5aee9e +sovrn.com, 217352, DIRECT, fafdf38b16bf6b2b +sovrn.com, 248396, DIRECT, fafdf38b16bf6b2b +sovrn.com, 260380, RESELLER, fafdf38b16bf6b2b +sovrn.com, 270524, RESELLER, fafdf38b16bf6b2b +sovrn.com,217352,DIRECT,fafdf38b16bf6b2b +sparcmedia.com, 310627, Direct +spotx.tv, 108933, RESELLER, 7842df1d2fe2db34 +spotx.tv, 147949, RESELLER, 7842df1d2fe2db34 +spotx.tv, 212457, RESELLER +spotx.tv, 228454, RESELLER, 7842df1d2fe2db34 +spotx.tv, 270977, DIRECT, 7842df1d2fe2db34 +spotx.tv, 285547, RESELLER, 7842df1d2fe2db34 # RhythmOne +spotx.tv, 71451, RESELLER, 7842df1d2fe2db34 # Taboola +spotx.tv, 84294, RESELLER, 7842df1d2fe2db34 +spotx.tv, 94794, RESELLER, 7842df1d2fe2db34 # SpotX +spotxchange.com, 108933, RESELLER, 7842df1d2fe2db34 +spotxchange.com, 147949, RESELLER, 7842df1d2fe2db34 +spotxchange.com, 212457, RESELLER +spotxchange.com, 228454, RESELLER, 7842df1d2fe2db34 +spotxchange.com, 270977, DIRECT, 7842df1d2fe2db34 +spotxchange.com, 285547, RESELLER, 7842df1d2fe2db34 # RhythmOne +spotxchange.com, 71451, RESELLER, 7842df1d2fe2db34 # Taboola +spotxchange.com, 84294, RESELLER, 7842df1d2fe2db34 +spotxchange.com, 94794, RESELLER, 7842df1d2fe2db34 # SpotX +springserve.com, 686, DIRECT, a24eb641fc82e93d +synacor.com, 82350, RESELLER, e108f11b2cdf7d5b +synacor.com,82151,reseller,e108f11b2cdf7d5b +teads.tv, 19014, DIRECT, 15a9c44f6d26cbe1 +telaria.com, mb9eo-oqsbf, RESELLER, 1a4e959a1b50034a +telaria.com, vtrdn-wjdav, DIRECT, 1a4e959a1b50034a +telaria.com, vtrdn-ysjam, DIRECT, 1a4e959a1b50034a +themediagrid.com, P5JONV, RESELLER, 35d5010d7789b49d # Media Grid (IPONWEB) +tremorhub.com, mb9eo-oqsbf, RESELLER, 1a4e959a1b50034a +tremorhub.com, vtrdn-wjdav, DIRECT, 1a4e959a1b50034a +tremorhub.com, vtrdn-ysjam, DIRECT, 1a4e959a1b50034a +tremorhub.com, z87wm, RESELLER, 1a4e959a1b50034a # Taboola +triplelift.com, 7205, DIRECT, 6c33edb13117fd86 +ucfunnel.com, par-488A3E6BD8D997D0ED8B3BD34D8BA4B, RESELLER # ucFunnel +vertamedia.com, 287605, DIRECT, 7de89dc7742b5b11 +vertamedia.com, 287605, RESELLER, 7de89dc7742b5b11 +video.unrulymedia.com, 2310154583, DIRECT +video.unrulymedia.com, 905992537, RESELLER, a670c89d4a324e47 # RhythmOne +yahoo.com, 55771, RESELLER, e1a5b5b6e3255540 +yahoo.com, 55104, DIRECT, e1a5b5b6e3255540 +yahoo.com, 55317, RESELLER # Verizon +yahoo.com, 57289, RESELLER, e1a5b5b6e3255540 +yahoo.com, 57695, DIRECT, e1a5b5b6e3255540 +yahoo.com,55029,RESELLER,e1a5b5b6e3255540 +yieldmo.com, 2417496099628458357, DIRECT diff --git a/docs/_extra/robots.txt b/docs/_extra/robots.txt new file mode 100644 index 000000000..eb0536286 --- /dev/null +++ b/docs/_extra/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: diff --git a/docs/_static/guide-book-cover.jpg b/docs/_static/guide-book-cover.jpg new file mode 100644 index 000000000..abbbc2871 Binary files /dev/null and b/docs/_static/guide-book-cover.jpg differ diff --git a/docs/_static/pep-0001-1.png b/docs/_static/pep-0001-1.png new file mode 100644 index 000000000..51eb2b258 Binary files /dev/null and b/docs/_static/pep-0001-1.png differ diff --git a/docs/_static/photos/32800783863_11a00db52c_k_d.jpg b/docs/_static/photos/32800783863_11a00db52c_k_d.jpg new file mode 100644 index 000000000..649272a69 Binary files /dev/null and b/docs/_static/photos/32800783863_11a00db52c_k_d.jpg differ diff --git a/docs/_static/photos/32800805573_568d6b72fd_k_d.jpg b/docs/_static/photos/32800805573_568d6b72fd_k_d.jpg new file mode 100644 index 000000000..208bbe8f9 Binary files /dev/null and b/docs/_static/photos/32800805573_568d6b72fd_k_d.jpg differ diff --git a/docs/_static/photos/33175624924_7febc46cc4_k_d.jpg b/docs/_static/photos/33175624924_7febc46cc4_k_d.jpg new file mode 100644 index 000000000..040660b87 Binary files /dev/null and b/docs/_static/photos/33175624924_7febc46cc4_k_d.jpg differ diff --git a/docs/_static/photos/33175625804_e225b90f3e_k_d.jpg b/docs/_static/photos/33175625804_e225b90f3e_k_d.jpg new file mode 100644 index 000000000..c356d03d3 Binary files /dev/null and b/docs/_static/photos/33175625804_e225b90f3e_k_d.jpg differ diff --git a/docs/_static/photos/33467946364_3e59bd376a_k_d.jpg b/docs/_static/photos/33467946364_3e59bd376a_k_d.jpg new file mode 100644 index 000000000..75a02fd7b Binary files /dev/null and b/docs/_static/photos/33467946364_3e59bd376a_k_d.jpg differ diff --git a/docs/_static/photos/33573755856_7f43d43adf_k_d.jpg b/docs/_static/photos/33573755856_7f43d43adf_k_d.jpg new file mode 100644 index 000000000..54781c3ec Binary files /dev/null and b/docs/_static/photos/33573755856_7f43d43adf_k_d.jpg differ diff --git a/docs/_static/photos/33573767786_eececc5d27_k_d.jpg b/docs/_static/photos/33573767786_eececc5d27_k_d.jpg new file mode 100644 index 000000000..1b529faad Binary files /dev/null and b/docs/_static/photos/33573767786_eececc5d27_k_d.jpg differ diff --git a/docs/_static/photos/33573769116_49c1ef51e7_k_d.jpg b/docs/_static/photos/33573769116_49c1ef51e7_k_d.jpg new file mode 100644 index 000000000..a7734c79d Binary files /dev/null and b/docs/_static/photos/33573769116_49c1ef51e7_k_d.jpg differ diff --git a/docs/_static/photos/33888714601_a1f7d020a2_k_d.jpg b/docs/_static/photos/33888714601_a1f7d020a2_k_d.jpg new file mode 100644 index 000000000..efdbea512 Binary files /dev/null and b/docs/_static/photos/33888714601_a1f7d020a2_k_d.jpg differ diff --git a/docs/_static/photos/33907143624_cd621b535c_k_d.jpg b/docs/_static/photos/33907143624_cd621b535c_k_d.jpg new file mode 100644 index 000000000..d7604c1a7 Binary files /dev/null and b/docs/_static/photos/33907143624_cd621b535c_k_d.jpg differ diff --git a/docs/_static/photos/33907149294_82d7535a6c_k_d.jpg b/docs/_static/photos/33907149294_82d7535a6c_k_d.jpg new file mode 100644 index 000000000..85bb549c8 Binary files /dev/null and b/docs/_static/photos/33907149294_82d7535a6c_k_d.jpg differ diff --git a/docs/_static/photos/33907150054_5ee79e8940_k_d.jpg b/docs/_static/photos/33907150054_5ee79e8940_k_d.jpg new file mode 100644 index 000000000..93e98f476 Binary files /dev/null and b/docs/_static/photos/33907150054_5ee79e8940_k_d.jpg differ diff --git a/docs/_static/photos/33907150594_9abba7ad0a_k_d.jpg b/docs/_static/photos/33907150594_9abba7ad0a_k_d.jpg new file mode 100644 index 000000000..480d6e153 Binary files /dev/null and b/docs/_static/photos/33907150594_9abba7ad0a_k_d.jpg differ diff --git a/docs/_static/photos/33907151034_e0a9e53402_k_d.jpg b/docs/_static/photos/33907151034_e0a9e53402_k_d.jpg new file mode 100644 index 000000000..ae0136d82 Binary files /dev/null and b/docs/_static/photos/33907151034_e0a9e53402_k_d.jpg differ diff --git a/docs/_static/photos/33907151224_0574e7dfc2_k_d.jpg b/docs/_static/photos/33907151224_0574e7dfc2_k_d.jpg new file mode 100644 index 000000000..cf218c710 Binary files /dev/null and b/docs/_static/photos/33907151224_0574e7dfc2_k_d.jpg differ diff --git a/docs/_static/photos/33907152464_a99fdcc8de_k_d.jpg b/docs/_static/photos/33907152464_a99fdcc8de_k_d.jpg new file mode 100644 index 000000000..91bfebbb0 Binary files /dev/null and b/docs/_static/photos/33907152464_a99fdcc8de_k_d.jpg differ diff --git a/docs/_static/photos/33907152824_bf91078cc1_k_d.jpg b/docs/_static/photos/33907152824_bf91078cc1_k_d.jpg new file mode 100644 index 000000000..7b3151fd5 Binary files /dev/null and b/docs/_static/photos/33907152824_bf91078cc1_k_d.jpg differ diff --git a/docs/_static/photos/33925223870_97e44f5629_k_d.jpg b/docs/_static/photos/33925223870_97e44f5629_k_d.jpg new file mode 100644 index 000000000..b271f261a Binary files /dev/null and b/docs/_static/photos/33925223870_97e44f5629_k_d.jpg differ diff --git a/docs/_static/photos/33928819683_97b5c6a184_k_d.jpg b/docs/_static/photos/33928819683_97b5c6a184_k_d.jpg new file mode 100644 index 000000000..8bdd9082c Binary files /dev/null and b/docs/_static/photos/33928819683_97b5c6a184_k_d.jpg differ diff --git a/docs/_static/photos/33928823133_2f3d32cf32_k_d.jpg b/docs/_static/photos/33928823133_2f3d32cf32_k_d.jpg new file mode 100644 index 000000000..995212043 Binary files /dev/null and b/docs/_static/photos/33928823133_2f3d32cf32_k_d.jpg differ diff --git a/docs/_static/photos/34018729885_002ced9b54_k_d.jpg b/docs/_static/photos/34018729885_002ced9b54_k_d.jpg new file mode 100644 index 000000000..5420bb6a1 Binary files /dev/null and b/docs/_static/photos/34018729885_002ced9b54_k_d.jpg differ diff --git a/docs/_static/photos/34018732105_f0e6758859_k_d.jpg b/docs/_static/photos/34018732105_f0e6758859_k_d.jpg new file mode 100644 index 000000000..1a4c3dd03 Binary files /dev/null and b/docs/_static/photos/34018732105_f0e6758859_k_d.jpg differ diff --git a/docs/_static/photos/34151833832_6bdfd930af_k_d.jpg b/docs/_static/photos/34151833832_6bdfd930af_k_d.jpg new file mode 100644 index 000000000..21fada7a6 Binary files /dev/null and b/docs/_static/photos/34151833832_6bdfd930af_k_d.jpg differ diff --git a/docs/_static/photos/34268661876_442428e122_k_d.jpg b/docs/_static/photos/34268661876_442428e122_k_d.jpg new file mode 100644 index 000000000..f6ce0be5c Binary files /dev/null and b/docs/_static/photos/34268661876_442428e122_k_d.jpg differ diff --git a/docs/_static/photos/34309496175_b82d104282_k_d.jpg b/docs/_static/photos/34309496175_b82d104282_k_d.jpg new file mode 100644 index 000000000..a09fd0a3d Binary files /dev/null and b/docs/_static/photos/34309496175_b82d104282_k_d.jpg differ diff --git a/docs/_static/photos/34364815780_bea6614025_k_d.jpg b/docs/_static/photos/34364815780_bea6614025_k_d.jpg new file mode 100644 index 000000000..ab05248ae Binary files /dev/null and b/docs/_static/photos/34364815780_bea6614025_k_d.jpg differ diff --git a/docs/_static/photos/34435687940_8f73fc1fa6_k_d.jpg b/docs/_static/photos/34435687940_8f73fc1fa6_k_d.jpg new file mode 100644 index 000000000..e765c7cf2 Binary files /dev/null and b/docs/_static/photos/34435687940_8f73fc1fa6_k_d.jpg differ diff --git a/docs/_static/photos/34435688380_b5a740762b_k_d.jpg b/docs/_static/photos/34435688380_b5a740762b_k_d.jpg new file mode 100644 index 000000000..baa1f17fc Binary files /dev/null and b/docs/_static/photos/34435688380_b5a740762b_k_d.jpg differ diff --git a/docs/_static/photos/34435688560_4cc2a7bcbb_k_d.jpg b/docs/_static/photos/34435688560_4cc2a7bcbb_k_d.jpg new file mode 100644 index 000000000..fe4c1aa40 Binary files /dev/null and b/docs/_static/photos/34435688560_4cc2a7bcbb_k_d.jpg differ diff --git a/docs/_static/photos/34435689480_2e6f358510_k_d.jpg b/docs/_static/photos/34435689480_2e6f358510_k_d.jpg new file mode 100644 index 000000000..87e278159 Binary files /dev/null and b/docs/_static/photos/34435689480_2e6f358510_k_d.jpg differ diff --git a/docs/_static/photos/34435690330_11930b5987_k_d.jpg b/docs/_static/photos/34435690330_11930b5987_k_d.jpg new file mode 100644 index 000000000..74b44e067 Binary files /dev/null and b/docs/_static/photos/34435690330_11930b5987_k_d.jpg differ diff --git a/docs/_static/photos/34435690580_3afec7d4cd_k_d.jpg b/docs/_static/photos/34435690580_3afec7d4cd_k_d.jpg new file mode 100644 index 000000000..4a00c547e Binary files /dev/null and b/docs/_static/photos/34435690580_3afec7d4cd_k_d.jpg differ diff --git a/docs/_static/photos/34484834733_5b80f65ab1_k_d.jpg b/docs/_static/photos/34484834733_5b80f65ab1_k_d.jpg new file mode 100644 index 000000000..8a667d23a Binary files /dev/null and b/docs/_static/photos/34484834733_5b80f65ab1_k_d.jpg differ diff --git a/docs/_static/photos/34575689432_3de8e9a348_k_d.jpg b/docs/_static/photos/34575689432_3de8e9a348_k_d.jpg new file mode 100644 index 000000000..88c760e87 Binary files /dev/null and b/docs/_static/photos/34575689432_3de8e9a348_k_d.jpg differ diff --git a/docs/_static/photos/34689432801_78d97ecec9_k_d.jpg b/docs/_static/photos/34689432801_78d97ecec9_k_d.jpg new file mode 100644 index 000000000..50554cfa6 Binary files /dev/null and b/docs/_static/photos/34689432801_78d97ecec9_k_d.jpg differ diff --git a/docs/_static/photos/34689452831_93d7fd0571_k_d.jpg b/docs/_static/photos/34689452831_93d7fd0571_k_d.jpg new file mode 100644 index 000000000..ab2ae0735 Binary files /dev/null and b/docs/_static/photos/34689452831_93d7fd0571_k_d.jpg differ diff --git a/docs/_static/photos/34725946825_0f85497e60_k_d.jpg b/docs/_static/photos/34725946825_0f85497e60_k_d.jpg new file mode 100644 index 000000000..5d58e91d3 Binary files /dev/null and b/docs/_static/photos/34725946825_0f85497e60_k_d.jpg differ diff --git a/docs/_static/photos/34725951345_c8f5959a2e_k_d.jpg b/docs/_static/photos/34725951345_c8f5959a2e_k_d.jpg new file mode 100644 index 000000000..c982f1fe8 Binary files /dev/null and b/docs/_static/photos/34725951345_c8f5959a2e_k_d.jpg differ diff --git a/docs/_static/photos/35254379756_c9fe23f843_k_d.jpg b/docs/_static/photos/35254379756_c9fe23f843_k_d.jpg new file mode 100644 index 000000000..c25560701 Binary files /dev/null and b/docs/_static/photos/35254379756_c9fe23f843_k_d.jpg differ diff --git a/docs/_static/photos/35294660055_42c02b2316_k_d.jpg b/docs/_static/photos/35294660055_42c02b2316_k_d.jpg new file mode 100644 index 000000000..f7cc6b936 Binary files /dev/null and b/docs/_static/photos/35294660055_42c02b2316_k_d.jpg differ diff --git a/docs/_static/photos/35620636012_f66aa88f93_k_d.jpg b/docs/_static/photos/35620636012_f66aa88f93_k_d.jpg new file mode 100644 index 000000000..e3a1b74a9 Binary files /dev/null and b/docs/_static/photos/35620636012_f66aa88f93_k_d.jpg differ diff --git a/docs/_static/photos/36137232412_fdcb0f84eb_k_d.jpg b/docs/_static/photos/36137232412_fdcb0f84eb_k_d.jpg new file mode 100644 index 000000000..ed1364a28 Binary files /dev/null and b/docs/_static/photos/36137232412_fdcb0f84eb_k_d.jpg differ diff --git a/docs/_static/photos/36137234682_be6898bf57_k_d.jpg b/docs/_static/photos/36137234682_be6898bf57_k_d.jpg new file mode 100644 index 000000000..fed85141d Binary files /dev/null and b/docs/_static/photos/36137234682_be6898bf57_k_d.jpg differ diff --git a/docs/_static/python-guide-logo.png b/docs/_static/python-guide-logo.png new file mode 100644 index 000000000..25e4f82c6 Binary files /dev/null and b/docs/_static/python-guide-logo.png differ diff --git a/docs/_static/social-card.jpg b/docs/_static/social-card.jpg new file mode 100644 index 000000000..9f74ef1e4 Binary files /dev/null and b/docs/_static/social-card.jpg differ diff --git a/docs/_static/test b/docs/_static/test deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/_templates/hacks.html b/docs/_templates/hacks.html new file mode 100644 index 000000000..cea323be6 --- /dev/null +++ b/docs/_templates/hacks.html @@ -0,0 +1 @@ + diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 000000000..6a6a22b8a --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,113 @@ +{% extends "!layout.html" %} + +{%- block extrahead %} + {# No super() because we want to avoid loading an empty custom.css file #} + + {# #} + + + + + {% if pagename == 'index' %} + + + {% elif pagename == '404' %} + {# No canonical on our 404 template. #} + {% else %} + + + {% endif %} + + + + + + + + + + + {%- if metatags is defined %} + {# FIXME: For some reason the `meta` dict is always empty. Extract the desc from the `metatags` text. #} + + {%- endif %} + + + + + + + {# Alabaster theme native GA integration is outdated (ga.js). #} + {# Insert our own GA snippet instead. #} + +{% endblock %} + +{# From: https://github.com/bitprophet/alabaster/blob/5f249677242be96601e034edb3697b7482a6abcf/alabaster/layout.html #} +{# Nav should appear before content, not after #} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +

Python Guide.

- This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis. +

+ + +

Feedback

- Feedback is greatly appreciated. If you have any questions, comments, - random praise, or anonymous threats, - shoot me an email. + This opinionated guide exists to provide both novice and expert Python developers a best practice handbook to the installation, configuration, and usage of Python on a daily basis.

O'Reilly Book

This guide is now available in tangible book form!

All proceeds are being directly donated to the DjangoGirls organization.

Contributors

+ This guide is the result of the collaboration of + hundreds of people + around the world, and your contributions + are welcome! +

Useful Links

-
• The Guide Website
-
• The Guide @ GitHub
-
• Issue Tracker
+
• The Guide Website
+
• The Guide @ GitHub
+
• Issue Tracker
+
• The Guide as a PDF
+

Translations

+
• English
+
• French
+
• Chinese
+
• Japanese
+
• Korean
+
• Filipino
+
• Brazilian Portuguese

Python Guide.

+ + + +

- This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis. + This opinionated guide exists to provide both novice and expert Python developers a best practice handbook to the installation, configuration, and usage of Python on a daily basis.

O'Reilly Book

This guide is now available in tangible book form!

All proceeds are being directly donated to the DjangoGirls organization.

Translations

+
• English
+
• French
+
• Chinese
+
• Japanese
+
• Korean
+
• Filipino
+
• Brazilian Portuguese
+

- -

Related Topics

-
• Documentation overview
  - {%- for parent in parents %} -
  • {{ parent.title }}
    - {%- endfor %} - {%- if prev %} -
    • Previous: {{ prev.title }}
    - {%- endif %} - {%- if next %} -
    • Next: {{ next.title }}
    - {%- endif %} - {%- for parent in parents %} -
  - {%- endfor %} -
-