From a1f84863252e937b3f93a65d8f5686ba3322bb7d Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 29 Oct 2014 08:11:46 +0100 Subject: Move HTML templates to their own subdir. --- Doc/conf.py | 2 +- Doc/tools/download.html | 65 ---------------------- Doc/tools/indexcontent.html | 59 -------------------- Doc/tools/indexsidebar.html | 18 ------ Doc/tools/layout.html | 102 ---------------------------------- Doc/tools/opensearch.xml | 4 -- Doc/tools/templates/download.html | 65 ++++++++++++++++++++++ Doc/tools/templates/indexcontent.html | 59 ++++++++++++++++++++ Doc/tools/templates/indexsidebar.html | 18 ++++++ Doc/tools/templates/layout.html | 102 ++++++++++++++++++++++++++++++++++ Doc/tools/templates/opensearch.xml | 4 ++ 11 files changed, 249 insertions(+), 249 deletions(-) delete mode 100644 Doc/tools/download.html delete mode 100644 Doc/tools/indexcontent.html delete mode 100644 Doc/tools/indexsidebar.html delete mode 100644 Doc/tools/layout.html delete mode 100644 Doc/tools/opensearch.xml create mode 100644 Doc/tools/templates/download.html create mode 100644 Doc/tools/templates/indexcontent.html create mode 100644 Doc/tools/templates/indexsidebar.html create mode 100644 Doc/tools/templates/layout.html create mode 100644 Doc/tools/templates/opensearch.xml diff --git a/Doc/conf.py b/Doc/conf.py index ff073b1..84458ff 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -53,7 +53,7 @@ html_short_title = '%s Documentation' % release html_last_updated_fmt = '%b %d, %Y' # Path to find HTML templates. -templates_path = ['tools'] +templates_path = ['tools/templates'] # Custom sidebar templates, filenames relative to this file. html_sidebars = { diff --git a/Doc/tools/download.html b/Doc/tools/download.html deleted file mode 100644 index 0550111..0000000 --- a/Doc/tools/download.html +++ /dev/null @@ -1,65 +0,0 @@ -{% extends "layout.html" %} -{% set title = 'Download' %} -{% if daily is defined %} - {% set dlbase = pathto('archives', 1) %} -{% else %} - {% set dlbase = 'http://docs.python.org/ftp/python/doc/' + release %} -{% endif %} - -{% block body %} -

Download Python {{ release }} Documentation

- -{% if last_updated %}

Last updated on: {{ last_updated }}.

{% endif %} - -

To download an archive containing all the documents for this version of -Python in one of various formats, follow one of links in this table. The numbers -in the table are the size of the download files in megabytes.

- - - - - - - - - - - - - - - - - - - - - - - -
FormatPacked as .zipPacked as .tar.bz2
PDF (US-Letter paper size)Download (ca. 8 MB)Download (ca. 8 MB)
PDF (A4 paper size)Download (ca. 8 MB)Download (ca. 8 MB)
HTMLDownload (ca. 6 MB)Download (ca. 4 MB)
Plain TextDownload (ca. 2 MB)Download (ca. 1.5 MB)
EPUBDownload (ca. 4.5 MB)
- -

These archives contain all the content in the documentation.

- -

HTML Help (.chm) files are made available in the "Windows" section -on the Python -download page.

- - -

Unpacking

- -

Unix users should download the .tar.bz2 archives; these are bzipped tar -archives and can be handled in the usual way using tar and the bzip2 -program. The InfoZIP unzip program can be -used to handle the ZIP archives if desired. The .tar.bz2 archives provide the -best compression and fastest download times.

- -

Windows users can use the ZIP archives since those are customary on that -platform. These are created on Unix using the InfoZIP zip program.

- - -

Problems

- -

If you have comments or suggestions for the Python documentation, please send -email to docs@python.org.

-{% endblock %} diff --git a/Doc/tools/indexcontent.html b/Doc/tools/indexcontent.html deleted file mode 100644 index 969099a..0000000 --- a/Doc/tools/indexcontent.html +++ /dev/null @@ -1,59 +0,0 @@ -{% extends "defindex.html" %} -{% block tables %} -

Parts of the documentation:

- - -
-

What's new in Python {{ version }}?
- or all "What's new" documents since 2.0

-

Tutorial
- start here

-

Library Reference
- keep this under your pillow

-

Language Reference
- describes syntax and language elements

-

Python Setup and Usage
- how to use Python on different platforms

-

Python HOWTOs
- in-depth documents on specific topics

- 		-

Installing Python Modules
- installing from the Python Package Index & other sources

-

Distributing Python Modules
- publishing modules for installation by others

-

Extending and Embedding
- tutorial for C/C++ programmers

-

Python/C API
- reference for C/C++ programmers

-

FAQs
- frequently asked questions (with answers!)

-
- -

Indices and tables:

- - -
-

Global Module Index
- quick access to all modules

-

General Index
- all functions, classes, terms

-

Glossary
- the most important terms explained

- 		-

Search page
- search this documentation

-

Complete Table of Contents
- lists all sections and subsections

-
- -

Meta information:

- - -
-

Reporting bugs

-

About the documentation

- 		-

History and License of Python

-

Copyright

-
-{% endblock %} diff --git a/Doc/tools/indexsidebar.html b/Doc/tools/indexsidebar.html deleted file mode 100644 index 83ba123..0000000 --- a/Doc/tools/indexsidebar.html +++ /dev/null @@ -1,18 +0,0 @@ -

Download

-

Download these documents

-

Docs for other versions

- - -

Other resources

- diff --git a/Doc/tools/layout.html b/Doc/tools/layout.html deleted file mode 100644 index d3b2801..0000000 --- a/Doc/tools/layout.html +++ /dev/null @@ -1,102 +0,0 @@ -{% extends "!layout.html" %} -{% block rootrellink %} -
    • -
  • Python{{ reldelim1 }}
    • -
  • - {%- if versionswitcher is defined %} - {{ release }} - Documentation{{ reldelim1 }} - {%- else %} - {{ shorttitle }}{{ reldelim1 }} - {%- endif %} -
    • -{% endblock %} -{% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} -{% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} -{% block extrahead %} - - {% if not embedded %}{% endif %} - {% if versionswitcher is defined and not embedded %}{% endif %} - {% if pagename == 'whatsnew/changelog' %} - - {% endif %} -{{ super() }} -{% endblock %} -{% block footer %} -
    - © Copyright {{ copyright|e }}. -
    - The Python Software Foundation is a non-profit corporation. - Please donate. -
    - Last updated on {{ last_updated|e }}. - Found a bug? -
    - Created using Sphinx {{ sphinx_version|e }}. -
    -{% endblock %} -{% block sidebarsourcelink %} -{%- if show_source and has_source and sourcename %} -

    {{ _('This Page') }}

    - -{%- endif %} -{% endblock %} diff --git a/Doc/tools/opensearch.xml b/Doc/tools/opensearch.xml deleted file mode 100644 index 69cec80..0000000 --- a/Doc/tools/opensearch.xml +++ /dev/null @@ -1,4 +0,0 @@ -{% extends "!opensearch.xml" %} -{% block extra -%} -http://www.python.org/images/favicon16x16.ico -{%- endblock %} diff --git a/Doc/tools/templates/download.html b/Doc/tools/templates/download.html new file mode 100644 index 0000000..0550111 --- /dev/null +++ b/Doc/tools/templates/download.html @@ -0,0 +1,65 @@ +{% extends "layout.html" %} +{% set title = 'Download' %} +{% if daily is defined %} + {% set dlbase = pathto('archives', 1) %} +{% else %} + {% set dlbase = 'http://docs.python.org/ftp/python/doc/' + release %} +{% endif %} + +{% block body %} +

    Download Python {{ release }} Documentation

    + +{% if last_updated %}

    Last updated on: {{ last_updated }}.

    {% endif %} + +

    To download an archive containing all the documents for this version of +Python in one of various formats, follow one of links in this table. The numbers +in the table are the size of the download files in megabytes.

    + + + + + + + + + + + + + + + + + + + + + + + +
    FormatPacked as .zipPacked as .tar.bz2
    PDF (US-Letter paper size)Download (ca. 8 MB)Download (ca. 8 MB)
    PDF (A4 paper size)Download (ca. 8 MB)Download (ca. 8 MB)
    HTMLDownload (ca. 6 MB)Download (ca. 4 MB)
    Plain TextDownload (ca. 2 MB)Download (ca. 1.5 MB)
    EPUBDownload (ca. 4.5 MB)
    + +

    These archives contain all the content in the documentation.

    + +

    HTML Help (.chm) files are made available in the "Windows" section +on the Python +download page.

    + + +

    Unpacking

    + +

    Unix users should download the .tar.bz2 archives; these are bzipped tar +archives and can be handled in the usual way using tar and the bzip2 +program. The InfoZIP unzip program can be +used to handle the ZIP archives if desired. The .tar.bz2 archives provide the +best compression and fastest download times.

    + +

    Windows users can use the ZIP archives since those are customary on that +platform. These are created on Unix using the InfoZIP zip program.

    + + +

    Problems

    + +

    If you have comments or suggestions for the Python documentation, please send +email to docs@python.org.

    +{% endblock %} diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html new file mode 100644 index 0000000..969099a --- /dev/null +++ b/Doc/tools/templates/indexcontent.html @@ -0,0 +1,59 @@ +{% extends "defindex.html" %} +{% block tables %} +

    Parts of the documentation:

    + + +
    +

    What's new in Python {{ version }}?
    + or all "What's new" documents since 2.0

    +

    Tutorial
    + start here

    +

    Library Reference
    + keep this under your pillow

    +

    Language Reference
    + describes syntax and language elements

    +

    Python Setup and Usage
    + how to use Python on different platforms

    +

    Python HOWTOs
    + in-depth documents on specific topics

    +     		+

    Installing Python Modules
    + installing from the Python Package Index & other sources

    +

    Distributing Python Modules
    + publishing modules for installation by others

    +

    Extending and Embedding
    + tutorial for C/C++ programmers

    +

    Python/C API
    + reference for C/C++ programmers

    +

    FAQs
    + frequently asked questions (with answers!)

    +
    + +

    Indices and tables:

    + + +
    +

    Global Module Index
    + quick access to all modules

    +

    General Index
    + all functions, classes, terms

    +

    Glossary
    + the most important terms explained

    +     		+

    Search page
    + search this documentation

    +

    Complete Table of Contents
    + lists all sections and subsections

    +
    + +

    Meta information:

    + + +
    +

    Reporting bugs

    +

    About the documentation

    +     		+

    History and License of Python

    +

    Copyright

    +
    +{% endblock %} diff --git a/Doc/tools/templates/indexsidebar.html b/Doc/tools/templates/indexsidebar.html new file mode 100644 index 0000000..83ba123 --- /dev/null +++ b/Doc/tools/templates/indexsidebar.html @@ -0,0 +1,18 @@ +

    Download

    +

    Download these documents

    +

    Docs for other versions

    + + +

    Other resources

    + diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html new file mode 100644 index 0000000..d3b2801 --- /dev/null +++ b/Doc/tools/templates/layout.html @@ -0,0 +1,102 @@ +{% extends "!layout.html" %} +{% block rootrellink %} +
    • +
  • Python{{ reldelim1 }}
    • +
  • + {%- if versionswitcher is defined %} + {{ release }} + Documentation{{ reldelim1 }} + {%- else %} + {{ shorttitle }}{{ reldelim1 }} + {%- endif %} +
    • +{% endblock %} +{% block relbar1 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} +{% block relbar2 %} {% if builder != 'qthelp' %} {{ relbar() }} {% endif %} {% endblock %} +{% block extrahead %} + + {% if not embedded %}{% endif %} + {% if versionswitcher is defined and not embedded %}{% endif %} + {% if pagename == 'whatsnew/changelog' %} + + {% endif %} +{{ super() }} +{% endblock %} +{% block footer %} +
    + © Copyright {{ copyright|e }}. +
    + The Python Software Foundation is a non-profit corporation. + Please donate. +
    + Last updated on {{ last_updated|e }}. + Found a bug? +
    + Created using Sphinx {{ sphinx_version|e }}. +
    +{% endblock %} +{% block sidebarsourcelink %} +{%- if show_source and has_source and sourcename %} +

    {{ _('This Page') }}

    + +{%- endif %} +{% endblock %} diff --git a/Doc/tools/templates/opensearch.xml b/Doc/tools/templates/opensearch.xml new file mode 100644 index 0000000..69cec80 --- /dev/null +++ b/Doc/tools/templates/opensearch.xml @@ -0,0 +1,4 @@ +{% extends "!opensearch.xml" %} +{% block extra -%} +http://www.python.org/images/favicon16x16.ico +{%- endblock %} -- cgit v0.12