From cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 15 Apr 2024 19:25:40 +0200 Subject: Adding upstream version 7.2.6. Signed-off-by: Daniel Baumann --- sphinx/templates/apidoc/module.rst_t | 9 +++ sphinx/templates/apidoc/package.rst_t | 57 ++++++++++++++ sphinx/templates/apidoc/toc.rst_t | 8 ++ sphinx/templates/epub3/container.xml | 6 ++ sphinx/templates/epub3/content.opf_t | 50 +++++++++++++ sphinx/templates/epub3/mimetype | 1 + sphinx/templates/epub3/nav.xhtml_t | 26 +++++++ sphinx/templates/epub3/toc.ncx_t | 24 ++++++ sphinx/templates/gettext/message.pot_t | 33 +++++++++ sphinx/templates/graphviz/graphviz.css | 19 +++++ sphinx/templates/htmlhelp/project.hhc | 31 ++++++++ sphinx/templates/htmlhelp/project.hhp | 21 ++++++ sphinx/templates/htmlhelp/project.stp | 33 +++++++++ sphinx/templates/imgmath/preview.tex_t | 18 +++++ sphinx/templates/imgmath/template.tex_t | 14 ++++ sphinx/templates/latex/latex.tex_t | 108 +++++++++++++++++++++++++++ sphinx/templates/latex/longtable.tex_t | 74 +++++++++++++++++++ sphinx/templates/latex/sphinxmessages.sty_t | 21 ++++++ sphinx/templates/latex/tabular.tex_t | 54 ++++++++++++++ sphinx/templates/latex/tabulary.tex_t | 54 ++++++++++++++ sphinx/templates/quickstart/Makefile.new_t | 21 ++++++ sphinx/templates/quickstart/Makefile_t | 98 +++++++++++++++++++++++++ sphinx/templates/quickstart/conf.py_t | 71 ++++++++++++++++++ sphinx/templates/quickstart/make.bat.new_t | 36 +++++++++ sphinx/templates/quickstart/make.bat_t | 110 ++++++++++++++++++++++++++++ sphinx/templates/quickstart/root_doc.rst_t | 21 ++++++ sphinx/templates/texinfo/Makefile | 57 ++++++++++++++ 27 files changed, 1075 insertions(+) create mode 100644 sphinx/templates/apidoc/module.rst_t create mode 100644 sphinx/templates/apidoc/package.rst_t create mode 100644 sphinx/templates/apidoc/toc.rst_t create mode 100644 sphinx/templates/epub3/container.xml create mode 100644 sphinx/templates/epub3/content.opf_t create mode 100644 sphinx/templates/epub3/mimetype create mode 100644 sphinx/templates/epub3/nav.xhtml_t create mode 100644 sphinx/templates/epub3/toc.ncx_t create mode 100644 sphinx/templates/gettext/message.pot_t create mode 100644 sphinx/templates/graphviz/graphviz.css create mode 100644 sphinx/templates/htmlhelp/project.hhc create mode 100644 sphinx/templates/htmlhelp/project.hhp create mode 100644 sphinx/templates/htmlhelp/project.stp create mode 100644 sphinx/templates/imgmath/preview.tex_t create mode 100644 sphinx/templates/imgmath/template.tex_t create mode 100644 sphinx/templates/latex/latex.tex_t create mode 100644 sphinx/templates/latex/longtable.tex_t create mode 100644 sphinx/templates/latex/sphinxmessages.sty_t create mode 100644 sphinx/templates/latex/tabular.tex_t create mode 100644 sphinx/templates/latex/tabulary.tex_t create mode 100644 sphinx/templates/quickstart/Makefile.new_t create mode 100644 sphinx/templates/quickstart/Makefile_t create mode 100644 sphinx/templates/quickstart/conf.py_t create mode 100644 sphinx/templates/quickstart/make.bat.new_t create mode 100644 sphinx/templates/quickstart/make.bat_t create mode 100644 sphinx/templates/quickstart/root_doc.rst_t create mode 100644 sphinx/templates/texinfo/Makefile (limited to 'sphinx/templates') diff --git a/sphinx/templates/apidoc/module.rst_t b/sphinx/templates/apidoc/module.rst_t new file mode 100644 index 0000000..2490278 --- /dev/null +++ b/sphinx/templates/apidoc/module.rst_t @@ -0,0 +1,9 @@ +{%- if show_headings %} +{{- [basename, "module"] | join(' ') | e | heading }} + +{% endif -%} +.. automodule:: {{ qualname }} +{%- for option in automodule_options %} + :{{ option }}: +{%- endfor %} + diff --git a/sphinx/templates/apidoc/package.rst_t b/sphinx/templates/apidoc/package.rst_t new file mode 100644 index 0000000..2229c31 --- /dev/null +++ b/sphinx/templates/apidoc/package.rst_t @@ -0,0 +1,57 @@ +{%- macro automodule(modname, options) -%} +.. automodule:: {{ modname }} +{%- for option in options %} + :{{ option }}: +{%- endfor %} +{%- endmacro %} + +{%- macro toctree(docnames) -%} +.. toctree:: + :maxdepth: {{ maxdepth }} +{% for docname in docnames %} + {{ docname }} +{%- endfor %} +{%- endmacro %} + +{%- if is_namespace %} +{{- [pkgname, "namespace"] | join(" ") | e | heading }} +{% else %} +{{- [pkgname, "package"] | join(" ") | e | heading }} +{% endif %} + +{%- if is_namespace %} +.. py:module:: {{ pkgname }} +{% endif %} + +{%- if modulefirst and not is_namespace %} +{{ automodule(pkgname, automodule_options) }} +{% endif %} + +{%- if subpackages %} +Subpackages +----------- + +{{ toctree(subpackages) }} +{% endif %} + +{%- if submodules %} +Submodules +---------- +{% if separatemodules %} +{{ toctree(submodules) }} +{% else %} +{%- for submodule in submodules %} +{% if show_headings %} +{{- [submodule, "module"] | join(" ") | e | heading(2) }} +{% endif %} +{{ automodule(submodule, automodule_options) }} +{% endfor %} +{%- endif %} +{%- endif %} + +{%- if not modulefirst and not is_namespace %} +Module contents +--------------- + +{{ automodule(pkgname, automodule_options) }} +{% endif %} diff --git a/sphinx/templates/apidoc/toc.rst_t b/sphinx/templates/apidoc/toc.rst_t new file mode 100644 index 0000000..f0877ee --- /dev/null +++ b/sphinx/templates/apidoc/toc.rst_t @@ -0,0 +1,8 @@ +{{ header | heading }} + +.. toctree:: + :maxdepth: {{ maxdepth }} +{% for docname in docnames %} + {{ docname }} +{%- endfor %} + diff --git a/sphinx/templates/epub3/container.xml b/sphinx/templates/epub3/container.xml new file mode 100644 index 0000000..326cf15 --- /dev/null +++ b/sphinx/templates/epub3/container.xml @@ -0,0 +1,6 @@ + + + + + + diff --git a/sphinx/templates/epub3/content.opf_t b/sphinx/templates/epub3/content.opf_t new file mode 100644 index 0000000..417888c --- /dev/null +++ b/sphinx/templates/epub3/content.opf_t @@ -0,0 +1,50 @@ + + + + {{ lang }} + {{ title }} + {{ description }} + {{ author }} + {{ contributor }} + {{ publisher }} + {{ copyright }} + {%- if epub_version == 3.1 %} + {{ id }} + {%- else %} + {{ id }} + {%- endif %} + {{ date }} + {{ date }} + {{ version }} + true + true + {{ ibook_scroll_axis }} + {%- if cover %} + + {%- endif %} + + + + + {%- for item in manifest_items %} + + {%- endfor %} + + + {%- for spine in spines %} + {%- if spine.linear %} + + {%- else %} + + {%- endif %} + {%- endfor %} + + + {%- for guide in guides %} + + {%- endfor %} + + diff --git a/sphinx/templates/epub3/mimetype b/sphinx/templates/epub3/mimetype new file mode 100644 index 0000000..57ef03f --- /dev/null +++ b/sphinx/templates/epub3/mimetype @@ -0,0 +1 @@ +application/epub+zip \ No newline at end of file diff --git a/sphinx/templates/epub3/nav.xhtml_t b/sphinx/templates/epub3/nav.xhtml_t new file mode 100644 index 0000000..2a32c20 --- /dev/null +++ b/sphinx/templates/epub3/nav.xhtml_t @@ -0,0 +1,26 @@ +{%- macro toctree(navlist) -%} +
    +{%- for nav in navlist %} +
  1. + {{ nav.text }} + {%- if nav.children %} +{{ toctree(nav.children)|indent(4, true) }} + {%- endif %} +
    2. +{%- endfor %} +
+{%- endmacro -%} + + + + + {{ toc_locale }} + + + + + diff --git a/sphinx/templates/epub3/toc.ncx_t b/sphinx/templates/epub3/toc.ncx_t new file mode 100644 index 0000000..0ea7ca3 --- /dev/null +++ b/sphinx/templates/epub3/toc.ncx_t @@ -0,0 +1,24 @@ +{%- macro navPoints(navlist) %} +{%- for nav in navlist %} + + + {{ nav.text }} + + {{ navPoints(nav.children)|indent(2, true) }} + +{%- endfor %} +{%- endmacro -%} + + + + + + + + + + {{ title }} + + {{ navPoints(navpoints)|indent(4, true) }} + + diff --git a/sphinx/templates/gettext/message.pot_t b/sphinx/templates/gettext/message.pot_t new file mode 100644 index 0000000..6138f54 --- /dev/null +++ b/sphinx/templates/gettext/message.pot_t @@ -0,0 +1,33 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) {{ copyright }} +# This file is distributed under the same license as the {{ project }} package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: {{ project|e }} {{ version|e }}\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: {{ ctime|e }}\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: {{ last_translator|e }}\n" +"Language-Team: {{ language_team|e }}\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +{% for message in messages %} +{% if display_location -%} +{% for source, line in message.locations -%} +#: {{ relpath(source) }}:{{ line }} +{% endfor -%} +{% endif -%} + +{% if display_uuid -%} +{% for uuid in message.uuids -%} +#: {{ uuid }} +{% endfor -%} +{% endif -%} + +msgid "{{ message.text|e }}" +msgstr "" +{% endfor -%} diff --git a/sphinx/templates/graphviz/graphviz.css b/sphinx/templates/graphviz/graphviz.css new file mode 100644 index 0000000..8d81c02 --- /dev/null +++ b/sphinx/templates/graphviz/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/sphinx/templates/htmlhelp/project.hhc b/sphinx/templates/htmlhelp/project.hhc new file mode 100644 index 0000000..705cfeb --- /dev/null +++ b/sphinx/templates/htmlhelp/project.hhc @@ -0,0 +1,31 @@ +{%- macro sitemap(name, docname) -%} + + + + +{%- endmacro -%} + + + + + + + + + + + + +
    +
  • + {{ sitemap(short_title, root_doc)|indent(8) }} +
    • + {%- for indexname, indexcls, content, collapse in domain_indices %} +
  • + {{ sitemap(indexcls.localname, indexname)|indent(8) }} +
    • + {%- endfor %} + {{ body|indent(6) }} +
+ + diff --git a/sphinx/templates/htmlhelp/project.hhp b/sphinx/templates/htmlhelp/project.hhp new file mode 100644 index 0000000..17edc1f --- /dev/null +++ b/sphinx/templates/htmlhelp/project.hhp @@ -0,0 +1,21 @@ +[OPTIONS] +Binary TOC=No +Binary Index=No +Compiled file={{ outname }}.chm +Contents file={{ outname }}.hhc +Default Window={{ outname }} +Default topic={{ root_doc }} +Display compile progress=No +Full text search stop list file={{ outname }}.stp +Full-text search=Yes +Index file={{ outname }}.hhk +Language={{ "%#x"|format(lcid) }} +Title={{ title }} + +[WINDOWS] +{{ outname }}="{{ title }}","{{ outname }}.hhc","{{ outname }}.hhk","{{ root_doc }}","{{ root_doc }}",,,,,0x63520,220,0x10384e,[0,0,1024,768],,,,,,,0 + +[FILES] +{%- for filename in files %} +{{ filename }} +{%- endfor %} diff --git a/sphinx/templates/htmlhelp/project.stp b/sphinx/templates/htmlhelp/project.stp new file mode 100644 index 0000000..bae1f90 --- /dev/null +++ b/sphinx/templates/htmlhelp/project.stp @@ -0,0 +1,33 @@ +a +and +are +as +at +be +but +by +for +if +in +into +is +it +near +no +not +of +on +or +such +that +the +their +then +there +these +they +this +to +was +will +with diff --git a/sphinx/templates/imgmath/preview.tex_t b/sphinx/templates/imgmath/preview.tex_t new file mode 100644 index 0000000..f3fdcda --- /dev/null +++ b/sphinx/templates/imgmath/preview.tex_t @@ -0,0 +1,18 @@ +\documentclass[12pt]{article} +\usepackage[utf8]{inputenc} +\usepackage{amsmath} +\usepackage{amsthm} +\usepackage{amssymb} +\usepackage{amsfonts} +\usepackage{anyfontsize} +\usepackage{bm} +\pagestyle{empty} +<%= preamble %> + +\usepackage[active<%= tightpage %>]{preview} + +\begin{document} +\begin{preview} +\fontsize{<%= fontsize %>}{<%= baselineskip %>}\selectfont <%= math %> +\end{preview} +\end{document} diff --git a/sphinx/templates/imgmath/template.tex_t b/sphinx/templates/imgmath/template.tex_t new file mode 100644 index 0000000..92fa8b0 --- /dev/null +++ b/sphinx/templates/imgmath/template.tex_t @@ -0,0 +1,14 @@ +\documentclass[12pt]{article} +\usepackage[utf8]{inputenc} +\usepackage{amsmath} +\usepackage{amsthm} +\usepackage{amssymb} +\usepackage{amsfonts} +\usepackage{anyfontsize} +\usepackage{bm} +\pagestyle{empty} +<%= preamble %> + +\begin{document} +\fontsize{<%= fontsize %>}{<%= baselineskip %>}\selectfont <%= math %> +\end{document} diff --git a/sphinx/templates/latex/latex.tex_t b/sphinx/templates/latex/latex.tex_t new file mode 100644 index 0000000..deb0305 --- /dev/null +++ b/sphinx/templates/latex/latex.tex_t @@ -0,0 +1,108 @@ +%% Generated by Sphinx. +\def\sphinxdocclass{<%= docclass %>} +<% if latex_engine == 'lualatex' -%> +\IfFileExists{luatex85.sty} + {\RequirePackage{luatex85}} + {\ifdefined\luatexversion\ifnum\luatexversion>84\relax + \PackageError{sphinx} + {** With this LuaTeX (\the\luatexversion),Sphinx requires luatex85.sty **} + {** Add the LaTeX package luatex85 to your TeX installation, and try again **} + \endinput\fi\fi} +<% endif -%> +\documentclass[<%= papersize %>,<%= pointsize %><%= classoptions %>]{<%= wrapperclass %>} +\ifdefined\pdfpxdimen + \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen +\fi \sphinxpxdimen=<%= pxunit %>\relax +\ifdefined\pdfimageresolution + \pdfimageresolution= \numexpr \dimexpr1in\relax/\sphinxpxdimen\relax +\fi +%% let collapsible pdf bookmarks panel have high depth per default +\PassOptionsToPackage{bookmarksdepth=5}{hyperref} +<% if use_xindy -%> +%% turn off hyperref patch of \index as sphinx.xdy xindy module takes care of +%% suitable \hyperpage mark-up, working around hyperref-xindy incompatibility +\PassOptionsToPackage{hyperindex=false}{hyperref} +%% memoir class requires extra handling +\makeatletter\@ifclassloaded{memoir} +{\ifdefined\memhyperindexfalse\memhyperindexfalse\fi}{}\makeatother +<% endif %> +<% if booktabs -%> +\PassOptionsToPackage{booktabs}{sphinx} +<% endif -%> +<% if borderless -%> +\PassOptionsToPackage{borderless}{sphinx} +<% endif -%> +<% if colorrows -%> +\PassOptionsToPackage{colorrows}{sphinx} +<% endif -%> +<%= passoptionstopackages %> +\PassOptionsToPackage{warn}{textcomp} +<%= inputenc %> +<%= utf8extra %> +<%= cmappkg %> +<%= fontenc %> +<%= amsmath %> +<%= multilingual %> +<%= substitutefont %> +<%= textcyrillic %> +<%= fontpkg %> +<%= fontsubstitution %> +<%= textgreek %> +<%= fncychap %> +\usepackage<%= sphinxpkgoptions %>{sphinx} +<%= sphinxsetup %> +<%= fvset %> +<%= geometry %> +<%= extrapackages %> + +<%- for name, option in packages %> +<%- if option %> +\usepackage[<%= option %>]{<%= name %>} +<%- else %> +\usepackage{<%= name %>} +<%- endif %> +<%- endfor %> + +<%= hyperref %> +<%- for name, option in packages_after_hyperref %> +<%- if option %> +\usepackage[<%= option %>]{<%= name %>} +<%- else %> +\usepackage{<%= name %>} +<%- endif %> +<%- endfor %> + +<%= contentsname %> +\usepackage{sphinxmessages} +<%= tocdepth %> +<%= secnumdepth %> +<%= preamble %> + +\title{<%= title %>} +\date{<%= date %>} +\release{<%= release | e %>} +\author{<%= author %>} +<%- if logofilename %> +\newcommand{\sphinxlogo}{\sphinxincludegraphics{<%= logofilename %>}\par} +<%- else %> +\newcommand{\sphinxlogo}{\vbox{}} +<%- endif %> +<%- if releasename or release %> +\renewcommand{\releasename}{<%= releasename or _('Release') | e %>} +<%- else %> +\renewcommand{\releasename}{} +<%- endif %> +<%= makeindex %> +\begin{document} +<%= shorthandoff %> +\pagestyle{empty} +<%= maketitle %> +\pagestyle{plain} +<%= tableofcontents %> +\pagestyle{normal} +<%= body %> +<%= atendofbody %> +<%= indices %> +\renewcommand{\indexname}{<%= _('Index') | e %>} +<%= printindex %> +\end{document} diff --git a/sphinx/templates/latex/longtable.tex_t b/sphinx/templates/latex/longtable.tex_t new file mode 100644 index 0000000..83790f4 --- /dev/null +++ b/sphinx/templates/latex/longtable.tex_t @@ -0,0 +1,74 @@ +\begin{savenotes} +\sphinxatlongtablestart +\sphinxthistablewithglobalstyle +<% if 'booktabs' in table.styles -%> +\sphinxthistablewithbooktabsstyle +<% endif -%> +<% if 'borderless' in table.styles -%> +\sphinxthistablewithborderlessstyle +<% endif -%> +<% if 'standard' in table.styles -%> +\sphinxthistablewithstandardstyle +<% endif -%> +<% if 'vlines' in table.styles -%> +\sphinxthistablewithvlinesstyle +<% endif -%> +<% if 'novlines' in table.styles -%> +\sphinxthistablewithnovlinesstyle +<% endif -%> +<% if 'colorrows' in table.styles -%> +\sphinxthistablewithcolorrowsstyle +<% endif -%> +<% if 'nocolorrows' in table.styles -%> +\sphinxthistablewithnocolorrowsstyle +<% endif -%> +\makeatletter +<%- if table.align in ('center', 'default') %> + \LTleft \@totalleftmargin plus1fill + \LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax plus1fill +<%- elif table.align == 'left' %> + \LTleft \@totalleftmargin + \LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax plus1fill +<%- elif table.align == 'right' %> + \LTleft \@totalleftmargin plus1fill + \LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax +<%- endif %> +\makeatother +\begin{longtable}<%= table.get_colspec() %> +<%- if table.caption -%> +\sphinxthelongtablecaptionisattop +\caption{<%= ''.join(table.caption) %>\strut}<%= labels %>\\*[\sphinxlongtablecapskipadjust] +<% elif labels -%> +\noalign{\phantomsection<%= labels %>}% +<% endif -%> +\sphinxtoprule +<%= ''.join(table.header) -%> +<%- if table.header -%> +\sphinxmidrule +<% endif -%> +\endfirsthead + +\multicolumn{<%= table.colcount %>}{c}{\sphinxnorowcolor + \makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} <%= _('continued from previous page') %>}}% +}\\ +\sphinxtoprule +<%= ''.join(table.header) -%> +<%- if table.header -%> +\sphinxmidrule +<% endif -%> +\endhead + +\sphinxbottomrule +\multicolumn{<%= table.colcount %>}{r}{\sphinxnorowcolor + \makebox[0pt][r]{\sphinxtablecontinued{<%= _('continues on next page') %>}}% +}\\ +\endfoot + +\endlastfoot +\sphinxtableatstartofbodyhook +<%= ''.join(table.body) -%> +\sphinxbottomrule +\end{longtable} +\sphinxtableafterendhook +\sphinxatlongtableend +\end{savenotes} diff --git a/sphinx/templates/latex/sphinxmessages.sty_t b/sphinx/templates/latex/sphinxmessages.sty_t new file mode 100644 index 0000000..ef2750f --- /dev/null +++ b/sphinx/templates/latex/sphinxmessages.sty_t @@ -0,0 +1,21 @@ +% +% sphinxmessages.sty +% +% message resources for Sphinx +% +\ProvidesPackage{sphinxmessages}[2019/01/04 v2.0 Localized LaTeX macros (Sphinx team)] + +\renewcommand{\literalblockcontinuedname}{<%= _('continued from previous page') | e %>} +\renewcommand{\literalblockcontinuesname}{<%= _('continues on next page') | e %>} +\renewcommand{\sphinxnonalphabeticalgroupname}{<%= _('Non-alphabetical') | e %>} +\renewcommand{\sphinxsymbolsname}{<%= _('Symbols') | e %>} +\renewcommand{\sphinxnumbersname}{<%= _('Numbers') | e %>} +\def\pageautorefname{<%= _('page') | e %>} + +<%= addtocaptions %>{\renewcommand{\figurename}{<%= figurename[0] | e | eabbr %>}} +\def\fnum@figure{\figurename\thefigure{}<%= figurename[1] | e %>} + +<%= addtocaptions %>{\renewcommand{\tablename}{<%= tablename[0] | e | eabbr %>}} +\def\fnum@table{\tablename\thetable{}<%= tablename[1] | e %>} + +<%= addtocaptions %>{\renewcommand{\literalblockname}{<%= literalblockname[0].strip() %>}} diff --git a/sphinx/templates/latex/tabular.tex_t b/sphinx/templates/latex/tabular.tex_t new file mode 100644 index 0000000..0a9310a --- /dev/null +++ b/sphinx/templates/latex/tabular.tex_t @@ -0,0 +1,54 @@ +\begin{savenotes}\sphinxattablestart +\sphinxthistablewithglobalstyle +<% if 'booktabs' in table.styles -%> +\sphinxthistablewithbooktabsstyle +<% endif -%> +<% if 'borderless' in table.styles -%> +\sphinxthistablewithborderlessstyle +<% endif -%> +<% if 'standard' in table.styles -%> +\sphinxthistablewithstandardstyle +<% endif -%> +<% if 'vlines' in table.styles -%> +\sphinxthistablewithvlinesstyle +<% endif -%> +<% if 'novlines' in table.styles -%> +\sphinxthistablewithnovlinesstyle +<% endif -%> +<% if 'colorrows' in table.styles -%> +\sphinxthistablewithcolorrowsstyle +<% endif -%> +<% if 'nocolorrows' in table.styles -%> +\sphinxthistablewithnocolorrowsstyle +<% endif -%> +<% if table.align -%> + <%- if table.align in ('center', 'default') -%> + \centering + <%- elif table.align == 'left' -%> + \raggedright + <%- else -%> + \raggedleft + <%- endif %> +<%- else -%> + \centering +<%- endif %> +<% if table.caption -%> +\sphinxcapstartof{table} +\sphinxthecaptionisattop +\sphinxcaption{<%= ''.join(table.caption) %>}<%= labels %> +\sphinxaftertopcaption +<% elif labels -%> +\phantomsection<%= labels %>\nobreak +<% endif -%> +\begin{tabular}[t]<%= table.get_colspec() -%> +\sphinxtoprule +<%= ''.join(table.header) -%> +<%- if table.header -%> +\sphinxmidrule +<% endif -%> +\sphinxtableatstartofbodyhook +<%=- ''.join(table.body) -%> +\sphinxbottomrule +\end{tabular} +\sphinxtableafterendhook\par +\sphinxattableend\end{savenotes} diff --git a/sphinx/templates/latex/tabulary.tex_t b/sphinx/templates/latex/tabulary.tex_t new file mode 100644 index 0000000..6ebcec6 --- /dev/null +++ b/sphinx/templates/latex/tabulary.tex_t @@ -0,0 +1,54 @@ +\begin{savenotes}\sphinxattablestart +\sphinxthistablewithglobalstyle +<% if 'booktabs' in table.styles -%> +\sphinxthistablewithbooktabsstyle +<% endif -%> +<% if 'borderless' in table.styles -%> +\sphinxthistablewithborderlessstyle +<% endif -%> +<% if 'standard' in table.styles -%> +\sphinxthistablewithstandardstyle +<% endif -%> +<% if 'vlines' in table.styles -%> +\sphinxthistablewithvlinesstyle +<% endif -%> +<% if 'novlines' in table.styles -%> +\sphinxthistablewithnovlinesstyle +<% endif -%> +<% if 'colorrows' in table.styles -%> +\sphinxthistablewithcolorrowsstyle +<% endif -%> +<% if 'nocolorrows' in table.styles -%> +\sphinxthistablewithnocolorrowsstyle +<% endif -%> +<% if table.align -%> + <%- if table.align in ('center', 'default') -%> + \centering + <%- elif table.align == 'left' -%> + \raggedright + <%- else -%> + \raggedleft + <%- endif %> +<%- else -%> + \centering +<%- endif %> +<% if table.caption -%> +\sphinxcapstartof{table} +\sphinxthecaptionisattop +\sphinxcaption{<%= ''.join(table.caption) %>}<%= labels %> +\sphinxaftertopcaption +<% elif labels -%> +\phantomsection<%= labels %>\nobreak +<% endif -%> +\begin{tabulary}{\linewidth}[t]<%= table.get_colspec() -%> +\sphinxtoprule +<%= ''.join(table.header) -%> +<%- if table.header -%> +\sphinxmidrule +<% endif -%> +\sphinxtableatstartofbodyhook +<%=- ''.join(table.body) -%> +\sphinxbottomrule +\end{tabulary} +\sphinxtableafterendhook\par +\sphinxattableend\end{savenotes} diff --git a/sphinx/templates/quickstart/Makefile.new_t b/sphinx/templates/quickstart/Makefile.new_t new file mode 100644 index 0000000..1a52757 --- /dev/null +++ b/sphinx/templates/quickstart/Makefile.new_t @@ -0,0 +1,21 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = {{ rsrcdir }} +BUILDDIR = {{ rbuilddir }} + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + diff --git a/sphinx/templates/quickstart/Makefile_t b/sphinx/templates/quickstart/Makefile_t new file mode 100644 index 0000000..14b2dc5 --- /dev/null +++ b/sphinx/templates/quickstart/Makefile_t @@ -0,0 +1,98 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +PAPER ?= +SOURCEDIR = {{ rsrcdir }} +BUILDDIR = {{ rbuilddir }} + +# Internal variables. +PAPEROPT_a4 = -D latex_elements.papersize=a4paper +PAPEROPT_letter = -D latex_elements.papersize=letterpaper +# $(O) is meant as a shortcut for $(SPHINXOPTS) +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(O) $(SOURCEDIR) +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(O) $(SOURCEDIR) + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and an HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @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 then PDFs out of them" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " lualatexpdf to make LaTeX files and run them through lualatex" + @echo " xelatexpdf to make LaTeX files and run them through xelatex" + @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)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + @echo " clean to remove everything in the build directory" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR) + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +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." + +.PHONY: lualatexpdf +lualatexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through lualatex..." + $(MAKE) PDFLATEX=lualatex -C $(BUILDDIR)/latex all-pdf + @echo "lualatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: xelatexpdf +xelatexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through xelatex..." + $(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf + @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: info +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." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + +# Catch-all target: route all unknown targets to Sphinx +.PHONY: Makefile +%: Makefile + $(SPHINXBUILD) -b "$@" $(ALLSPHINXOPTS) "$(BUILDDIR)/$@" + diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t new file mode 100644 index 0000000..3836486 --- /dev/null +++ b/sphinx/templates/quickstart/conf.py_t @@ -0,0 +1,71 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +{% if append_syspath -%} +# -- Path setup -------------------------------------------------------------- + +import os +import sys +sys.path.insert(0, {{ module_path | repr }}) + +{% endif -%} +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = {{ project | repr }} +copyright = {{ copyright | repr }} +author = {{ author | repr }} + +{%- if version %} + +version = {{ version | repr }} +{%- endif %} +{%- if release %} +release = {{ release | repr }} +{%- endif %} + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [{% if extensions %} +{%- for ext in extensions %} + '{{ ext }}', +{%- endfor %} +{% endif %}] + +templates_path = ['{{ dot }}templates'] +exclude_patterns = [{{ exclude_patterns }}] + +{% if suffix != '.rst' -%} +source_suffix = {{ suffix | repr }} +{% endif -%} + +{% if root_doc != 'index' -%} +root_doc = {{ root_doc | repr }} +{% endif -%} + +{% if language -%} +language = {{ language | repr }} +{%- endif %} + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['{{ dot }}static'] +{% if 'sphinx.ext.intersphinx' in extensions %} +# -- Options for intersphinx extension --------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} +{% endif -%} +{% if 'sphinx.ext.todo' in extensions %} +# -- Options for todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration + +todo_include_todos = True +{% endif %} diff --git a/sphinx/templates/quickstart/make.bat.new_t b/sphinx/templates/quickstart/make.bat.new_t new file mode 100644 index 0000000..c89237b --- /dev/null +++ b/sphinx/templates/quickstart/make.bat.new_t @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR={{ rsrcdir }} +set BUILDDIR={{ rbuilddir }} + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd + diff --git a/sphinx/templates/quickstart/make.bat_t b/sphinx/templates/quickstart/make.bat_t new file mode 100644 index 0000000..dfc619a --- /dev/null +++ b/sphinx/templates/quickstart/make.bat_t @@ -0,0 +1,110 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +pushd %~dp0 + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR={{ rbuilddir }} +set SOURCEDIR={{ rsrcdir }} +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %O% %SOURCEDIR% +set I18NSPHINXOPTS=%SPHINXOPTS% %SOURCEDIR% +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_elements.papersize=%PAPER%paper %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_elements.papersize=%PAPER%paper %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and an HTML help project + echo. qthelp to make HTML files and a Qt help project + echo. devhelp to make HTML files and a Devhelp project + 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 then PDFs out of them + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over 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 + echo. coverage to run coverage check of the documentation if enabled + echo. dummy to check syntax errors of document sources + echo. clean to remove everything in the build directory + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 1>NUL 2>NUL +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + goto end +) + +%SPHINXBUILD% -b %1 %ALLSPHINXOPTS% %BUILDDIR%/%1 +goto end + +:end +popd + diff --git a/sphinx/templates/quickstart/root_doc.rst_t b/sphinx/templates/quickstart/root_doc.rst_t new file mode 100644 index 0000000..3aa98af --- /dev/null +++ b/sphinx/templates/quickstart/root_doc.rst_t @@ -0,0 +1,21 @@ +.. {{ project }} documentation master file, created by + sphinx-quickstart on {{ now }}. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to {{ project }}'s documentation! +==========={{ project_underline }}================= + +.. toctree:: + :maxdepth: {{ mastertocmaxdepth }} + :caption: Contents: + +{{ mastertoctree }} + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/sphinx/templates/texinfo/Makefile b/sphinx/templates/texinfo/Makefile new file mode 100644 index 0000000..e3b732c --- /dev/null +++ b/sphinx/templates/texinfo/Makefile @@ -0,0 +1,57 @@ +# Makefile for Sphinx Texinfo output + +infodir ?= /usr/share/info + +MAKEINFO = makeinfo --no-split +MAKEINFO_html = makeinfo --no-split --html +MAKEINFO_plaintext = makeinfo --no-split --plaintext +TEXI2PDF = texi2pdf --batch --expand +INSTALL_INFO = install-info + +ALLDOCS = $(basename $(wildcard *.texi)) + +all: info +info: $(addsuffix .info,$(ALLDOCS)) +plaintext: $(addsuffix .txt,$(ALLDOCS)) +html: $(addsuffix .html,$(ALLDOCS)) +pdf: $(addsuffix .pdf,$(ALLDOCS)) + +install-info: info + for f in *.info; do \ + mkdir -p $(infodir) && \ + cp "$$f" $(infodir) && \ + $(INSTALL_INFO) --info-dir=$(infodir) "$$f" && \ + \ + FIGURE_DIR="`basename \"$$f\" .info`-figures" && \ + if [ -e "$$FIGURE_DIR" ]; then \ + cp -r "$$FIGURE_DIR" $(infodir) ; \ + fi; \ + done + +uninstall-info: info + for f in *.info; do \ + rm -f "$(infodir)/$$f" ; \ + rm -rf "$(infodir)/`basename '$$f' .info`-figures" && \ + $(INSTALL_INFO) --delete --info-dir=$(infodir) "$$f" ; \ + done + +%.info: %.texi + $(MAKEINFO) -o '$@' '$<' + +%.txt: %.texi + $(MAKEINFO_plaintext) -o '$@' '$<' + +%.html: %.texi + $(MAKEINFO_html) -o '$@' '$<' + +%.pdf: %.texi + -$(TEXI2PDF) '$<' + -$(TEXI2PDF) '$<' + -$(TEXI2PDF) '$<' + +clean: + rm -f *.info *.pdf *.txt *.html + rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ky *.pg + rm -f *.vr *.tp *.fn *.fns *.def *.defs *.cp *.cps *.ge *.ges *.mo + +.PHONY: all info plaintext html pdf install-info uninstall-info clean -- cgit v1.2.3