ó ÿgdSc@sNdZddlZddlZddlZddlZddlmZeejdeƒZ ddl m Z ddl m Z ddlmZddlmZmZmZmZmZmZdd lmZdd lmZy eZWnek rüeZnXd Zej d d fkr!dZ!ndZ!e!d7Z!dZ"dZ#dZ$dZ%dZ&dZ'dZ(d„Z)de*fd„ƒYZ+d„Z,d„Z-d„Z.d„Z/d„Z0d „Z1ee-d!„Z2ej d d fkr#ej3d"ƒd#„Z4x1d$d%d&gD] Z5e4e6ƒe5ƒe6ƒe5 iiu#!/usr/bin/env python3 uuq # -*- coding: utf-8 -*- # # %(project)s documentation build configuration file, created by # sphinx-quickstart on %(now)s. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [%(extensions)s] # Add any paths that contain templates here, relative to this directory. templates_path = ['%(dot)stemplates'] # The suffix of source filenames. source_suffix = '%(suffix)s' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = '%(master_str)s' # General information about the project. project = u'%(project_str)s' copyright = u'%(copyright_str)s' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '%(version_str)s' # The full version, including alpha/beta/rc tags. release = '%(release_str)s' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%%B %%d, %%Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [%(exclude_patterns)s] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['%(dot)sstatic'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. #html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%%b %%d, %%Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = '%(project_fn)sdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ('%(master_str)s', '%(project_fn)s.tex', u'%(project_doc_texescaped_str)s', u'%(author_texescaped_str)s', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('%(master_str)s', '%(project_manpage)s', u'%(project_doc_str)s', [u'%(author_str)s'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('%(master_str)s', '%(project_fn)s', u'%(project_doc_str)s', u'%(author_str)s', '%(project_fn)s', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False u # -- Options for Epub output ---------------------------------------------- # Bibliographic Dublin Core info. epub_title = u'%(project_str)s' epub_author = u'%(author_str)s' epub_publisher = u'%(author_str)s' epub_copyright = u'%(copyright_str)s' # The basename for the epub file. It defaults to the project name. #epub_basename = u'%(project_str)s' # The HTML theme for the epub output. Since the default themes are not optimized # for small screen space, using the same theme for HTML and epub output is # usually not wise. This defaults to 'epub', a theme designed to save visual # space. #epub_theme = 'epub' # The language of the text. It defaults to the language option # or en if the language is not set. #epub_language = '' # The scheme of the identifier. Typical schemes are ISBN or URL. #epub_scheme = '' # The unique identifier of the text. This can be a ISBN number # or the project homepage. #epub_identifier = '' # A unique identification for the text. #epub_uid = '' # A tuple containing the cover image and cover page html template filenames. #epub_cover = () # A sequence of (type, uri, title) tuples for the guide element of content.opf. #epub_guide = () # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_pre_files = [] # HTML files shat should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # The depth of the table of contents in toc.ncx. #epub_tocdepth = 3 # Allow duplicate toc entries. #epub_tocdup = True # Choose between 'default' and 'includehidden'. #epub_tocscope = 'default' # Fix unsupported image types using the PIL. #epub_fix_images = False # Scale large images. #epub_max_image_width = 0 # How to display URL addresses: 'footnote', 'no', or 'inline'. #epub_show_urls = 'inline' # If false, no index is generated. #epub_use_index = True u‰ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} uÔ.. %(project)s documentation master file, created by sphinx-quickstart on %(now)s. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to %(project)s's documentation! ===========%(project_underline)s================= Contents: .. toctree:: :maxdepth: %(mastertocmaxdepth)s %(mastertoctree)s Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` u¥# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = %(rbuilddir)s # 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) %(rsrcdir)s # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) %(rsrcdir)s .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 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 a HTML help project" @echo " qthelp to make HTML files and a qthelp 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 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)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/%(project_fn)s.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/%(project_fn)s.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/%(project_fn)s" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/%(project_fn)s" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." 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." 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: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/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 @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." 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." uH@ECHO OFF REM Command file for Sphinx documentation if "%%SPHINXBUILD%%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=%(rbuilddir)s set ALLSPHINXOPTS=-d %%BUILDDIR%%/doctrees %%SPHINXOPTS%% %(rsrcdir)s set I18NSPHINXOPTS=%%SPHINXOPTS%% %(rsrcdir)s if NOT "%%PAPER%%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%%PAPER%% %%ALLSPHINXOPTS%% set I18NSPHINXOPTS=-D latex_paper_size=%%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 a HTML help project echo. qthelp to make HTML files and a qthelp 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. 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 goto end ) if "%%1" == "clean" ( for /d %%%%i in (%%BUILDDIR%%\*) do rmdir /q /s %%%%i del /q /s %%BUILDDIR%%\* goto end ) %%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.http://sphinx-doc.org/ exit /b 1 ) if "%%1" == "html" ( %%SPHINXBUILD%% -b html %%ALLSPHINXOPTS%% %%BUILDDIR%%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %%BUILDDIR%%/html. goto end ) if "%%1" == "dirhtml" ( %%SPHINXBUILD%% -b dirhtml %%ALLSPHINXOPTS%% %%BUILDDIR%%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %%BUILDDIR%%/dirhtml. goto end ) if "%%1" == "singlehtml" ( %%SPHINXBUILD%% -b singlehtml %%ALLSPHINXOPTS%% %%BUILDDIR%%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %%BUILDDIR%%/singlehtml. goto end ) if "%%1" == "pickle" ( %%SPHINXBUILD%% -b pickle %%ALLSPHINXOPTS%% %%BUILDDIR%%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%%1" == "json" ( %%SPHINXBUILD%% -b json %%ALLSPHINXOPTS%% %%BUILDDIR%%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%%1" == "htmlhelp" ( %%SPHINXBUILD%% -b htmlhelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %%BUILDDIR%%/htmlhelp. goto end ) if "%%1" == "qthelp" ( %%SPHINXBUILD%% -b qthelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %%BUILDDIR%%/qthelp, like this: echo.^> qcollectiongenerator %%BUILDDIR%%\qthelp\%(project_fn)s.qhcp echo.To view the help file: echo.^> assistant -collectionFile %%BUILDDIR%%\qthelp\%(project_fn)s.ghc goto end ) if "%%1" == "devhelp" ( %%SPHINXBUILD%% -b devhelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%%1" == "epub" ( %%SPHINXBUILD%% -b epub %%ALLSPHINXOPTS%% %%BUILDDIR%%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %%BUILDDIR%%/epub. goto end ) if "%%1" == "latex" ( %%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %%BUILDDIR%%/latex. goto end ) if "%%1" == "latexpdf" ( %%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex cd %%BUILDDIR%%/latex make all-pdf cd %%BUILDDIR%%/.. 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 %%BUILDDIR%%/.. echo. echo.Build finished; the PDF files are in %%BUILDDIR%%/latex. goto end ) if "%%1" == "text" ( %%SPHINXBUILD%% -b text %%ALLSPHINXOPTS%% %%BUILDDIR%%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %%BUILDDIR%%/text. goto end ) if "%%1" == "man" ( %%SPHINXBUILD%% -b man %%ALLSPHINXOPTS%% %%BUILDDIR%%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %%BUILDDIR%%/man. goto end ) if "%%1" == "texinfo" ( %%SPHINXBUILD%% -b texinfo %%ALLSPHINXOPTS%% %%BUILDDIR%%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %%BUILDDIR%%/texinfo. goto end ) if "%%1" == "gettext" ( %%SPHINXBUILD%% -b gettext %%I18NSPHINXOPTS%% %%BUILDDIR%%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %%BUILDDIR%%/locale. goto end ) if "%%1" == "changes" ( %%SPHINXBUILD%% -b changes %%ALLSPHINXOPTS%% %%BUILDDIR%%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %%BUILDDIR%%/changes. goto end ) if "%%1" == "linkcheck" ( %%SPHINXBUILD%% -b linkcheck %%ALLSPHINXOPTS%% %%BUILDDIR%%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %%BUILDDIR%%/linkcheck/output.txt. goto end ) if "%%1" == "doctest" ( %%SPHINXBUILD%% -b doctest %%ALLSPHINXOPTS%% %%BUILDDIR%%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %%BUILDDIR%%/doctest/output.txt. goto end ) if "%%1" == "xml" ( %%SPHINXBUILD%% -b xml %%ALLSPHINXOPTS%% %%BUILDDIR%%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %%BUILDDIR%%/xml. goto end ) if "%%1" == "pseudoxml" ( %%SPHINXBUILD%% -b pseudoxml %%ALLSPHINXOPTS%% %%BUILDDIR%%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %%BUILDDIR%%/pseudoxml. goto end ) :end uI# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = %(project_fn)s SOURCEDIR = %(rsrcdir)s BUILDDIR = %(rbuilddir)s # 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 # Has to be explicit, otherwise we don't get "make" without targets right. help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) # You can add custom targets here. # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) ué@ECHO OFF REM Command file for Sphinx documentation if "%%SPHINXBUILD%%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=%(rbuilddir)s set SPHINXPROJ=%(project_fn)s if "%%1" == "" goto help %%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.http://sphinx-doc.org/ exit /b 1 ) %%SPHINXBUILD%% -M %%1 %%BUILDDIR%% %%SPHINXOPTS%% goto end :help %%SPHINXBUILD%% -M help %%BUILDDIR%% %%SPHINXOPTS%% :end cCs$tj|ƒrdStj|ƒdS(N(Rtisdirtostmakedirs(tdir((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytmkdir_pstValidationErrorcBseZdZRS(sRaised for validation errors.(t__name__t __module__t__doc__(((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pyR•scCs2tj|ƒr.tj|ƒ r.tdƒ‚n|S(NsPlease enter a valid path name.(RtexistsR R(tx((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytis_path˜scCs|stdƒ‚n|S(NsPlease enter some text.(R(R((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytnonemptyscs‡fd†}|S(Ncs,|ˆkr(tddjˆƒƒ‚n|S(NsPlease enter one of %s.s, (Rtjoin(R(tl(s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytval£s ((RR((Rs;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytchoice¢scCs1|jƒdkr!tdƒ‚n|jƒdkS(NtYtYEStNtNOsPlease enter either 'y' or 'n'.(RRR R!(RR(tupperR(R((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytboolean©scCs8|dd!dko"t|ƒdks4tdƒ‚n|S(Niit.s2Please enter a file suffix, e.g. '.rst' or '.txt'.(tlenR(R((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytsuffix®s%cCs|S(N((R((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytok´scCsÝxÌtrÎ|r&td||f}nt|d}tjd krÆ|jddƒjddƒ|krÆtr|jtƒ}qÃtdƒGHy|jdƒ}WqÃtk r¿|jd ƒ}qÃXqÆnt |ƒ}t |ƒj ƒ}|rú| rú|}nt |t ƒsŒ|jddƒjddƒ|krŒtrE|jtƒ}q‰td ƒGHy|jdƒ}Wq‰tk r…|jd ƒ}q‰XqŒny||ƒ}Wn+tk rÉ}td t|ƒƒGHqnXPqW|||GHt |d:sphinx-quickstart will not overwrite existing Sphinx projects.s4Please enter a new root path (or just Enter to exit)titsepsÊ You have two options for placing the build directory for Sphinx output. Either, you use a directory "_build" within the root path, or you separate "source" and "build" directories within the root path.s+Separate source and build directories (y/n)tntdotsë Inside the root directory, two more directories will be created; "_templates" for custom HTML templates and "_static" for custom stylesheets and other static files. You can enter another prefix (such as ".") to replace the underscore.s(Name prefix for templates and static dirt_tprojectsJ The project name will occur in several places in the built documentation.s Project nametauthorsAuthor name(s)tversions/ Sphinx has the notion of a "version" and a "release" for the software. Each version can have multiple releases. For example, for Python the version is something like 2.5 or 3.0, while the release is something like 2.5.1 or 3.0a1. If you don't need this dual structure, just set both to the same value.sProject versiontreleasesProject releaseR&s‰ The file name suffix for source files. Commonly, this is either ".txt" or ".rst". Only files with this suffix are considered documents.sSource file suffixs.rsttmasters One document is special in that it is considered the top node of the "contents tree", that is, it is the root of the hierarchical structure of the documents. Normally, this is "index", but if your "index" document is a custom template, you can also set this to another filename.s-Name of your master document (without suffix)tindexsKError: the master file %s has already been found in the selected root path.s7sphinx-quickstart will not overwrite the existing file.sIPlease enter a new file name, or rename the existing file and press Entertepubs3 Sphinx can also add configuration for epub output:s)Do you want to use the epub builder (y/n)t ext_autodocsK Please indicate if you want to use one of the following Sphinx extensions:s;autodoc: automatically insert docstrings from modules (y/n)t ext_doctestsAdoctest: automatically test code snippets in doctest blocks (y/n)text_intersphinxsJintersphinx: link between Sphinx documentation of different projects (y/n)text_todosEtodo: write "todo" entries that can be shown or hidden on build (y/n)t ext_coverages1coverage: checks for documentation coverage (y/n)t ext_pngmaths3pngmath: include math, rendered as PNG images (y/n)t ext_mathjaxs?mathjax: include math, rendered in the browser by MathJax (y/n)sZNote: pngmath and mathjax cannot be enabled at the same time. pngmath has been deselected.t ext_ifconfigsGifconfig: conditional inclusion of content based on config values (y/n)t ext_viewcodesMviewcode: include links to the source code of documented Python objects (y/n)tmakefiles˜ A Makefile and a Windows command file can be generated for you so that you only have to run e.g. `make html' instead of invoking sphinx-build directly.sCreate Makefile? (y/n)tyt batchfiles"Create Windows command file? (y/n)N( RRR@RRtisfileRR-texitR#R'R&tFalse(R9((s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytask_userñs¸ ""               ..                                    c sOtjƒdF}dˆkr)dˆdƒtˆd?ƒn|r d@SHtdAƒGHdB| ˆd7s1ˆd=r7dCpDdD||fdEGHd@S(Is(Generate project based on values in *d*.t it mastertoctreeRHtmastertocmaxdepthiRMt project_fntproject_manpagetnowt=tproject_underlines, c3s2|](}ˆjd|ƒrtd|ƒVqdS(text_s sphinx.ext.N(tgettrepr(t.0tname(R9(s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pys œstautodoctdoctestt intersphinxttodotcoveragetpngmathtmathjaxtifconfigtviewcodes t extensionss%Ys, RNt copyrighttauthor_texescapeds Documentationt project_doctproject_doc_texescapedRORPRQs\s\\t's\'t_strRRIRBtbuildtexclude_patternsRKt templateststaticcsiˆstj|ƒ r\d|GHt|dddd|ƒ}z|j|ƒWd|jƒXn d|GHdS(NsCreating file %s.twtRsutf-8tnewlines!File %s already exists, skipping.(RR`R twritetclose(tfpathtcontentR†tf(t overwrite(s;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pyt write_fileÂs RSRVsconf.pyR&R]R$trsrcdirt rbuilddirtMakefileu R_smake.batu Ns:Finished: An initial directory structure has been created.sZ You should now populate your master file %s and create other documentation source files. s=Use the Makefile to build the docs, like so: make builder sZUse the sphinx-build command to build the docs, like so: sphinx-build -b builder %s %s sQwhere "builder" is one of the supported builders, e.g. html, latex or linkcheck. s ( RqRrRsRtRuRvRwRxRy( sprojectR}R~sauthorR|s copyrightsversionsreleasesmaster(R tinitRtlowerttimetasctimeRRtstrftimeR6t translatettex_escape_mapR)RR RRntNoneRERFRmRGt MASTER_FILEtMAKEFILEt BATCHFILER( R9RŒtsilenttindentRzR:tsrcdirtbuilddirRt conf_textt masterfile((R9RŒs;/usr/local/lib/python2.7/site-packages/sphinx/quickstart.pytgenerateŒs|          .*        "' "' /cCs tƒstƒni}t|ƒdkr@dGHtjdƒn#t|ƒdkrc|d|d sX0.    ÿH½õ"$       . ›h