| # -*- coding: utf-8 -*- |
| """ |
| sphinx.quickstart |
| ~~~~~~~~~~~~~~~~~ |
| |
| Quickly setup documentation source to work with Sphinx. |
| |
| :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. |
| :license: BSD, see LICENSE for details. |
| """ |
| from __future__ import print_function |
| |
| import sys, os, time, re |
| from os import path |
| from io import open |
| |
| TERM_ENCODING = getattr(sys.stdin, 'encoding', None) |
| |
| #try to import readline, unix specific enhancement |
| try: |
| import readline |
| if readline.__doc__ and 'libedit' in readline.__doc__: |
| readline.parse_and_bind("bind ^I rl_complete") |
| else: |
| readline.parse_and_bind("tab: complete") |
| except ImportError: |
| pass |
| |
| from six import PY2, PY3, text_type |
| from six.moves import input |
| from docutils.utils import column_width |
| |
| from sphinx import __version__ |
| from sphinx.util.osutil import make_filename |
| from sphinx.util.console import purple, bold, red, turquoise, \ |
| nocolor, color_terminal |
| from sphinx.util import texescape |
| |
| # function to get input from terminal -- overridden by the test suite |
| term_input = input |
| |
| |
| PROMPT_PREFIX = '> ' |
| |
| if PY3: |
| # prevents that the file is checked for being written in Python 2.x syntax |
| QUICKSTART_CONF = u'#!/usr/bin/env python3\n' |
| else: |
| QUICKSTART_CONF = u'' |
| |
| QUICKSTART_CONF += u'''\ |
| # -*- 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. |
| # |
| # This is also used if you do content translation via gettext catalogs. |
| # Usually you set "language" from the command line for these cases. |
| language = %(language)r |
| |
| # 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 |
| # "<project> v<release> 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 <link> 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 |
| |
| # Language to be used for generating the HTML full-text search index. |
| # Sphinx supports the following languages: |
| # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
| # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
| #html_search_language = 'en' |
| |
| # A dictionary with options for the search language support, empty by default. |
| # Now only 'ja' uses this config value |
| #html_search_options = {'type': 'default'} |
| |
| # The name of a javascript file (relative to the configuration directory) that |
| # implements a search results scorer. If empty, the default will be used. |
| #html_search_scorer = 'scorer.js' |
| |
| # 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': '', |
| |
| # Latex figure (float) alignment |
| #'figure_align': 'htbp', |
| } |
| |
| # Grouping the document tree into LaTeX files. List of tuples |
| # (source start file, target name, title, |
| # author, documentclass [howto, manual, or own class]). |
| latex_documents = [ |
| ('%(master_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 |
| ''' |
| |
| EPUB_CONFIG = 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 |
| ''' |
| |
| INTERSPHINX_CONFIG = u''' |
| |
| # Example configuration for intersphinx: refer to the Python standard library. |
| intersphinx_mapping = {'http://docs.python.org/': None} |
| ''' |
| |
| MASTER_FILE = 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` |
| |
| ''' |
| |
| MAKEFILE = 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 coverage gettext |
| |
| help: |
| \t@echo "Please use \\`make <target>' where <target> is one of" |
| \t@echo " html to make standalone HTML files" |
| \t@echo " dirhtml to make HTML files named index.html in directories" |
| \t@echo " singlehtml to make a single large HTML file" |
| \t@echo " pickle to make pickle files" |
| \t@echo " json to make JSON files" |
| \t@echo " htmlhelp to make HTML files and a HTML help project" |
| \t@echo " qthelp to make HTML files and a qthelp project" |
| \t@echo " devhelp to make HTML files and a Devhelp project" |
| \t@echo " epub to make an epub" |
| \t@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
| \t@echo " latexpdf to make LaTeX files and run them through pdflatex" |
| \t@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" |
| \t@echo " text to make text files" |
| \t@echo " man to make manual pages" |
| \t@echo " texinfo to make Texinfo files" |
| \t@echo " info to make Texinfo files and run them through makeinfo" |
| \t@echo " gettext to make PO message catalogs" |
| \t@echo " changes to make an overview of all changed/added/deprecated items" |
| \t@echo " xml to make Docutils-native XML files" |
| \t@echo " pseudoxml to make pseudoxml-XML files for display purposes" |
| \t@echo " linkcheck to check all external links for integrity" |
| \t@echo " doctest to run all doctests embedded in the documentation \ |
| (if enabled)" |
| \t@echo " coverage to run coverage check of the documentation (if enabled)" |
| |
| clean: |
| \trm -rf $(BUILDDIR)/* |
| |
| html: |
| \t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
| \t@echo |
| \t@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
| |
| dirhtml: |
| \t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
| \t@echo |
| \t@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
| |
| singlehtml: |
| \t$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
| \t@echo |
| \t@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
| |
| pickle: |
| \t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
| \t@echo |
| \t@echo "Build finished; now you can process the pickle files." |
| |
| json: |
| \t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
| \t@echo |
| \t@echo "Build finished; now you can process the JSON files." |
| |
| htmlhelp: |
| \t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
| \t@echo |
| \t@echo "Build finished; now you can run HTML Help Workshop with the" \\ |
| \t ".hhp project file in $(BUILDDIR)/htmlhelp." |
| |
| qthelp: |
| \t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
| \t@echo |
| \t@echo "Build finished; now you can run "qcollectiongenerator" with the" \\ |
| \t ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
| \t@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/%(project_fn)s.qhcp" |
| \t@echo "To view the help file:" |
| \t@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/%(project_fn)s.qhc" |
| |
| devhelp: |
| \t$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
| \t@echo |
| \t@echo "Build finished." |
| \t@echo "To view the help file:" |
| \t@echo "# mkdir -p $$HOME/.local/share/devhelp/%(project_fn)s" |
| \t@echo "# ln -s $(BUILDDIR)/devhelp\ |
| $$HOME/.local/share/devhelp/%(project_fn)s" |
| \t@echo "# devhelp" |
| |
| epub: |
| \t$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
| \t@echo |
| \t@echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
| |
| latex: |
| \t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
| \t@echo |
| \t@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
| \t@echo "Run \\`make' in that directory to run these through (pdf)latex" \\ |
| \t "(use \\`make latexpdf' here to do that automatically)." |
| |
| latexpdf: |
| \t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
| \t@echo "Running LaTeX files through pdflatex..." |
| \t$(MAKE) -C $(BUILDDIR)/latex all-pdf |
| \t@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
| |
| latexpdfja: |
| \t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
| \t@echo "Running LaTeX files through platex and dvipdfmx..." |
| \t$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja |
| \t@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
| |
| text: |
| \t$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
| \t@echo |
| \t@echo "Build finished. The text files are in $(BUILDDIR)/text." |
| |
| man: |
| \t$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
| \t@echo |
| \t@echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
| |
| texinfo: |
| \t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
| \t@echo |
| \t@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
| \t@echo "Run \\`make' in that directory to run these through makeinfo" \\ |
| \t "(use \\`make info' here to do that automatically)." |
| |
| info: |
| \t$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
| \t@echo "Running Texinfo files through makeinfo..." |
| \tmake -C $(BUILDDIR)/texinfo info |
| \t@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
| |
| gettext: |
| \t$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale |
| \t@echo |
| \t@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." |
| |
| changes: |
| \t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
| \t@echo |
| \t@echo "The overview file is in $(BUILDDIR)/changes." |
| |
| linkcheck: |
| \t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
| \t@echo |
| \t@echo "Link check complete; look for any errors in the above output " \\ |
| \t "or in $(BUILDDIR)/linkcheck/output.txt." |
| |
| doctest: |
| \t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
| \t@echo "Testing of doctests in the sources finished, look at the " \\ |
| \t "results in $(BUILDDIR)/doctest/output.txt." |
| |
| coverage: |
| \t$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage |
| \t@echo "Testing of coverage in the sources finished, look at the " \\ |
| \t "results in $(BUILDDIR)/coverage/python.txt." |
| |
| xml: |
| \t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
| \t@echo |
| \t@echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
| |
| pseudoxml: |
| \t$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
| \t@echo |
| \t@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
| ''' |
| |
| BATCHFILE = u'''\ |
| @ECHO OFF |
| |
| REM Command file for Sphinx documentation |
| |
| if "%%SPHINXBUILD%%" == "" ( |
| \tset SPHINXBUILD=sphinx-build |
| ) |
| set BUILDDIR=%(rbuilddir)s |
| set ALLSPHINXOPTS=-d %%BUILDDIR%%/doctrees %%SPHINXOPTS%% %(rsrcdir)s |
| set I18NSPHINXOPTS=%%SPHINXOPTS%% %(rsrcdir)s |
| if NOT "%%PAPER%%" == "" ( |
| \tset ALLSPHINXOPTS=-D latex_paper_size=%%PAPER%% %%ALLSPHINXOPTS%% |
| \tset I18NSPHINXOPTS=-D latex_paper_size=%%PAPER%% %%I18NSPHINXOPTS%% |
| ) |
| |
| if "%%1" == "" goto help |
| |
| if "%%1" == "help" ( |
| \t:help |
| \techo.Please use `make ^<target^>` where ^<target^> is one of |
| \techo. html to make standalone HTML files |
| \techo. dirhtml to make HTML files named index.html in directories |
| \techo. singlehtml to make a single large HTML file |
| \techo. pickle to make pickle files |
| \techo. json to make JSON files |
| \techo. htmlhelp to make HTML files and a HTML help project |
| \techo. qthelp to make HTML files and a qthelp project |
| \techo. devhelp to make HTML files and a Devhelp project |
| \techo. epub to make an epub |
| \techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
| \techo. text to make text files |
| \techo. man to make manual pages |
| \techo. texinfo to make Texinfo files |
| \techo. gettext to make PO message catalogs |
| \techo. changes to make an overview over all changed/added/deprecated items |
| \techo. xml to make Docutils-native XML files |
| \techo. pseudoxml to make pseudoxml-XML files for display purposes |
| \techo. linkcheck to check all external links for integrity |
| \techo. doctest to run all doctests embedded in the documentation if enabled |
| \techo. coverage to run coverage check of the documentation if enabled |
| \tgoto end |
| ) |
| |
| if "%%1" == "clean" ( |
| \tfor /d %%%%i in (%%BUILDDIR%%\*) do rmdir /q /s %%%%i |
| \tdel /q /s %%BUILDDIR%%\* |
| \tgoto end |
| ) |
| |
| |
| REM Check if sphinx-build is available and fallback to Python version if any |
| %%SPHINXBUILD%% 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 ( |
| \techo. |
| \techo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
| \techo.installed, then set the SPHINXBUILD environment variable to point |
| \techo.to the full path of the 'sphinx-build' executable. Alternatively you |
| \techo.may add the Sphinx directory to PATH. |
| \techo. |
| \techo.If you don't have Sphinx installed, grab it from |
| \techo.http://sphinx-doc.org/ |
| \texit /b 1 |
| ) |
| |
| :sphinx_ok |
| |
| |
| if "%%1" == "html" ( |
| \t%%SPHINXBUILD%% -b html %%ALLSPHINXOPTS%% %%BUILDDIR%%/html |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The HTML pages are in %%BUILDDIR%%/html. |
| \tgoto end |
| ) |
| |
| if "%%1" == "dirhtml" ( |
| \t%%SPHINXBUILD%% -b dirhtml %%ALLSPHINXOPTS%% %%BUILDDIR%%/dirhtml |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The HTML pages are in %%BUILDDIR%%/dirhtml. |
| \tgoto end |
| ) |
| |
| if "%%1" == "singlehtml" ( |
| \t%%SPHINXBUILD%% -b singlehtml %%ALLSPHINXOPTS%% %%BUILDDIR%%/singlehtml |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The HTML pages are in %%BUILDDIR%%/singlehtml. |
| \tgoto end |
| ) |
| |
| if "%%1" == "pickle" ( |
| \t%%SPHINXBUILD%% -b pickle %%ALLSPHINXOPTS%% %%BUILDDIR%%/pickle |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished; now you can process the pickle files. |
| \tgoto end |
| ) |
| |
| if "%%1" == "json" ( |
| \t%%SPHINXBUILD%% -b json %%ALLSPHINXOPTS%% %%BUILDDIR%%/json |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished; now you can process the JSON files. |
| \tgoto end |
| ) |
| |
| if "%%1" == "htmlhelp" ( |
| \t%%SPHINXBUILD%% -b htmlhelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/htmlhelp |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished; now you can run HTML Help Workshop with the ^ |
| .hhp project file in %%BUILDDIR%%/htmlhelp. |
| \tgoto end |
| ) |
| |
| if "%%1" == "qthelp" ( |
| \t%%SPHINXBUILD%% -b qthelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/qthelp |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished; now you can run "qcollectiongenerator" with the ^ |
| .qhcp project file in %%BUILDDIR%%/qthelp, like this: |
| \techo.^> qcollectiongenerator %%BUILDDIR%%\\qthelp\\%(project_fn)s.qhcp |
| \techo.To view the help file: |
| \techo.^> assistant -collectionFile %%BUILDDIR%%\\qthelp\\%(project_fn)s.ghc |
| \tgoto end |
| ) |
| |
| if "%%1" == "devhelp" ( |
| \t%%SPHINXBUILD%% -b devhelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/devhelp |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. |
| \tgoto end |
| ) |
| |
| if "%%1" == "epub" ( |
| \t%%SPHINXBUILD%% -b epub %%ALLSPHINXOPTS%% %%BUILDDIR%%/epub |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The epub file is in %%BUILDDIR%%/epub. |
| \tgoto end |
| ) |
| |
| if "%%1" == "latex" ( |
| \t%%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished; the LaTeX files are in %%BUILDDIR%%/latex. |
| \tgoto end |
| ) |
| |
| if "%%1" == "latexpdf" ( |
| \t%%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex |
| \tcd %%BUILDDIR%%/latex |
| \tmake all-pdf |
| \tcd %%BUILDDIR%%/.. |
| \techo. |
| \techo.Build finished; the PDF files are in %%BUILDDIR%%/latex. |
| \tgoto end |
| ) |
| |
| if "%%1" == "latexpdfja" ( |
| \t%%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex |
| \tcd %%BUILDDIR%%/latex |
| \tmake all-pdf-ja |
| \tcd %%BUILDDIR%%/.. |
| \techo. |
| \techo.Build finished; the PDF files are in %%BUILDDIR%%/latex. |
| \tgoto end |
| ) |
| |
| if "%%1" == "text" ( |
| \t%%SPHINXBUILD%% -b text %%ALLSPHINXOPTS%% %%BUILDDIR%%/text |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The text files are in %%BUILDDIR%%/text. |
| \tgoto end |
| ) |
| |
| if "%%1" == "man" ( |
| \t%%SPHINXBUILD%% -b man %%ALLSPHINXOPTS%% %%BUILDDIR%%/man |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The manual pages are in %%BUILDDIR%%/man. |
| \tgoto end |
| ) |
| |
| if "%%1" == "texinfo" ( |
| \t%%SPHINXBUILD%% -b texinfo %%ALLSPHINXOPTS%% %%BUILDDIR%%/texinfo |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The Texinfo files are in %%BUILDDIR%%/texinfo. |
| \tgoto end |
| ) |
| |
| if "%%1" == "gettext" ( |
| \t%%SPHINXBUILD%% -b gettext %%I18NSPHINXOPTS%% %%BUILDDIR%%/locale |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The message catalogs are in %%BUILDDIR%%/locale. |
| \tgoto end |
| ) |
| |
| if "%%1" == "changes" ( |
| \t%%SPHINXBUILD%% -b changes %%ALLSPHINXOPTS%% %%BUILDDIR%%/changes |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.The overview file is in %%BUILDDIR%%/changes. |
| \tgoto end |
| ) |
| |
| if "%%1" == "linkcheck" ( |
| \t%%SPHINXBUILD%% -b linkcheck %%ALLSPHINXOPTS%% %%BUILDDIR%%/linkcheck |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Link check complete; look for any errors in the above output ^ |
| or in %%BUILDDIR%%/linkcheck/output.txt. |
| \tgoto end |
| ) |
| |
| if "%%1" == "doctest" ( |
| \t%%SPHINXBUILD%% -b doctest %%ALLSPHINXOPTS%% %%BUILDDIR%%/doctest |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Testing of doctests in the sources finished, look at the ^ |
| results in %%BUILDDIR%%/doctest/output.txt. |
| \tgoto end |
| ) |
| |
| if "%%1" == "coverage" ( |
| \t%%SPHINXBUILD%% -b coverage %%ALLSPHINXOPTS%% %%BUILDDIR%%/coverage |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Testing of coverage in the sources finished, look at the ^ |
| results in %%BUILDDIR%%/coverage/python.txt. |
| \tgoto end |
| ) |
| |
| if "%%1" == "xml" ( |
| \t%%SPHINXBUILD%% -b xml %%ALLSPHINXOPTS%% %%BUILDDIR%%/xml |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The XML files are in %%BUILDDIR%%/xml. |
| \tgoto end |
| ) |
| |
| if "%%1" == "pseudoxml" ( |
| \t%%SPHINXBUILD%% -b pseudoxml %%ALLSPHINXOPTS%% %%BUILDDIR%%/pseudoxml |
| \tif errorlevel 1 exit /b 1 |
| \techo. |
| \techo.Build finished. The pseudo-XML files are in %%BUILDDIR%%/pseudoxml. |
| \tgoto end |
| ) |
| |
| :end |
| ''' |
| |
| # This will become the Makefile template for Sphinx 1.5. |
| MAKEFILE_NEW = u'''\ |
| # 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: |
| \t@$(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). |
| %: |
| \t@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
| ''' |
| |
| # This will become the make.bat template for Sphinx 1.5. |
| BATCHFILE_NEW = u'''\ |
| @ECHO OFF |
| |
| REM Command file for Sphinx documentation |
| |
| if "%%SPHINXBUILD%%" == "" ( |
| \tset SPHINXBUILD=sphinx-build |
| ) |
| set BUILDDIR=%(rbuilddir)s |
| set SPHINXPROJ=%(project_fn)s |
| |
| if "%%1" == "" goto help |
| |
| %%SPHINXBUILD%% 2> nul |
| if errorlevel 9009 ( |
| \techo. |
| \techo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
| \techo.installed, then set the SPHINXBUILD environment variable to point |
| \techo.to the full path of the 'sphinx-build' executable. Alternatively you |
| \techo.may add the Sphinx directory to PATH. |
| \techo. |
| \techo.If you don't have Sphinx installed, grab it from |
| \techo.http://sphinx-doc.org/ |
| \texit /b 1 |
| ) |
| |
| %%SPHINXBUILD%% -M %%1 %%BUILDDIR%% %%SPHINXOPTS%% |
| goto end |
| |
| :help |
| %%SPHINXBUILD%% -M help %%BUILDDIR%% %%SPHINXOPTS%% |
| |
| :end |
| ''' |
| |
| |
| def mkdir_p(dir): |
| if path.isdir(dir): |
| return |
| os.makedirs(dir) |
| |
| |
| class ValidationError(Exception): |
| """Raised for validation errors.""" |
| |
| def is_path(x): |
| x = path.expanduser(x) |
| if path.exists(x) and not path.isdir(x): |
| raise ValidationError("Please enter a valid path name.") |
| return x |
| |
| def nonempty(x): |
| if not x: |
| raise ValidationError("Please enter some text.") |
| return x |
| |
| def choice(*l): |
| def val(x): |
| if x not in l: |
| raise ValidationError('Please enter one of %s.' % ', '.join(l)) |
| return x |
| return val |
| |
| def boolean(x): |
| if x.upper() not in ('Y', 'YES', 'N', 'NO'): |
| raise ValidationError("Please enter either 'y' or 'n'.") |
| return x.upper() in ('Y', 'YES') |
| |
| def suffix(x): |
| if not (x[0:1] == '.' and len(x) > 1): |
| raise ValidationError("Please enter a file suffix, " |
| "e.g. '.rst' or '.txt'.") |
| return x |
| |
| def ok(x): |
| return x |
| |
| |
| def do_prompt(d, key, text, default=None, validator=nonempty): |
| while True: |
| if default: |
| prompt = PROMPT_PREFIX + '%s [%s]: ' % (text, default) |
| else: |
| prompt = PROMPT_PREFIX + text + ': ' |
| if PY2: |
| # for Python 2.x, try to get a Unicode string out of it |
| if prompt.encode('ascii', 'replace').decode('ascii', 'replace') \ |
| != prompt: |
| if TERM_ENCODING: |
| prompt = prompt.encode(TERM_ENCODING) |
| else: |
| print(turquoise('* Note: non-ASCII default value provided ' |
| 'and terminal encoding unknown -- assuming ' |
| 'UTF-8 or Latin-1.')) |
| try: |
| prompt = prompt.encode('utf-8') |
| except UnicodeEncodeError: |
| prompt = prompt.encode('latin1') |
| prompt = purple(prompt) |
| x = term_input(prompt).strip() |
| if default and not x: |
| x = default |
| if not isinstance(x, text_type): |
| # for Python 2.x, try to get a Unicode string out of it |
| if x.decode('ascii', 'replace').encode('ascii', 'replace') != x: |
| if TERM_ENCODING: |
| x = x.decode(TERM_ENCODING) |
| else: |
| print(turquoise('* Note: non-ASCII characters entered ' |
| 'and terminal encoding unknown -- assuming ' |
| 'UTF-8 or Latin-1.')) |
| try: |
| x = x.decode('utf-8') |
| except UnicodeDecodeError: |
| x = x.decode('latin1') |
| try: |
| x = validator(x) |
| except ValidationError as err: |
| print(red('* ' + str(err))) |
| continue |
| break |
| d[key] = x |
| |
| |
| if PY3: |
| # remove Unicode literal prefixes |
| def _convert_python_source(source, rex=re.compile(r"[uU]('.*?')")): |
| return rex.sub('\\1', source) |
| |
| for f in ['QUICKSTART_CONF', 'EPUB_CONFIG', 'INTERSPHINX_CONFIG']: |
| globals()[f] = _convert_python_source(globals()[f]) |
| |
| del _convert_python_source |
| |
| |
| def ask_user(d): |
| """Ask the user for quickstart values missing from *d*. |
| |
| Values are: |
| |
| * path: root path |
| * sep: separate source and build dirs (bool) |
| * dot: replacement for dot in _templates etc. |
| * project: project name |
| * author: author names |
| * version: version of project |
| * release: release of project |
| * language: document language |
| * suffix: source file suffix |
| * master: master document name |
| * epub: use epub (bool) |
| * ext_*: extensions to use (bools) |
| * makefile: make Makefile |
| * batchfile: make command file |
| """ |
| |
| print(bold('Welcome to the Sphinx %s quickstart utility.') % __version__) |
| print(''' |
| Please enter values for the following settings (just press Enter to |
| accept a default value, if one is given in brackets).''') |
| |
| if 'path' in d: |
| print(bold(''' |
| Selected root path: %s''' % d['path'])) |
| else: |
| print(''' |
| Enter the root path for documentation.''') |
| do_prompt(d, 'path', 'Root path for the documentation', '.', is_path) |
| |
| while path.isfile(path.join(d['path'], 'conf.py')) or \ |
| path.isfile(path.join(d['path'], 'source', 'conf.py')): |
| print() |
| print(bold('Error: an existing conf.py has been found in the ' |
| 'selected root path.')) |
| print('sphinx-quickstart will not overwrite existing Sphinx projects.') |
| print() |
| do_prompt(d, 'path', 'Please enter a new root path (or just Enter ' |
| 'to exit)', '', is_path) |
| if not d['path']: |
| sys.exit(1) |
| |
| if 'sep' not in d: |
| print(''' |
| 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.''') |
| do_prompt(d, 'sep', 'Separate source and build directories (y/n)', 'n', |
| boolean) |
| |
| if 'dot' not in d: |
| print(''' |
| 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.''') |
| do_prompt(d, 'dot', 'Name prefix for templates and static dir', '_', ok) |
| |
| if 'project' not in d: |
| print(''' |
| The project name will occur in several places in the built documentation.''') |
| do_prompt(d, 'project', 'Project name') |
| if 'author' not in d: |
| do_prompt(d, 'author', 'Author name(s)') |
| |
| if 'version' not in d: |
| print(''' |
| 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.''') |
| do_prompt(d, 'version', 'Project version') |
| if 'release' not in d: |
| do_prompt(d, 'release', 'Project release', d['version']) |
| |
| if 'language' not in d: |
| print(''' |
| If the documents are to be written in a language other than English, |
| you can select a language here by its language code. Sphinx will then |
| translate text that it generates into that language. |
| |
| For a list of supported codes, see |
| http://sphinx-doc.org/config.html#confval-language.''') |
| do_prompt(d, 'language', 'Project language', 'en') |
| if d['language'] == 'en': |
| d['language'] = None |
| |
| if 'suffix' not in d: |
| print(''' |
| The file name suffix for source files. Commonly, this is either ".txt" |
| or ".rst". Only files with this suffix are considered documents.''') |
| do_prompt(d, 'suffix', 'Source file suffix', '.rst', suffix) |
| |
| if 'master' not in d: |
| print(''' |
| 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.''') |
| do_prompt(d, 'master', 'Name of your master document (without suffix)', |
| 'index') |
| |
| while path.isfile(path.join(d['path'], d['master']+d['suffix'])) or \ |
| path.isfile(path.join(d['path'], 'source', d['master']+d['suffix'])): |
| print() |
| print(bold('Error: the master file %s has already been found in the ' |
| 'selected root path.' % (d['master']+d['suffix']))) |
| print('sphinx-quickstart will not overwrite the existing file.') |
| print() |
| do_prompt(d, 'master', 'Please enter a new file name, or rename the ' |
| 'existing file and press Enter', d['master']) |
| |
| if 'epub' not in d: |
| print(''' |
| Sphinx can also add configuration for epub output:''') |
| do_prompt(d, 'epub', 'Do you want to use the epub builder (y/n)', |
| 'n', boolean) |
| |
| if 'ext_autodoc' not in d: |
| print(''' |
| Please indicate if you want to use one of the following Sphinx extensions:''') |
| do_prompt(d, 'ext_autodoc', 'autodoc: automatically insert docstrings ' |
| 'from modules (y/n)', 'n', boolean) |
| if 'ext_doctest' not in d: |
| do_prompt(d, 'ext_doctest', 'doctest: automatically test code snippets ' |
| 'in doctest blocks (y/n)', 'n', boolean) |
| if 'ext_intersphinx' not in d: |
| do_prompt(d, 'ext_intersphinx', 'intersphinx: link between Sphinx ' |
| 'documentation of different projects (y/n)', 'n', boolean) |
| if 'ext_todo' not in d: |
| do_prompt(d, 'ext_todo', 'todo: write "todo" entries ' |
| 'that can be shown or hidden on build (y/n)', 'n', boolean) |
| if 'ext_coverage' not in d: |
| do_prompt(d, 'ext_coverage', 'coverage: checks for documentation ' |
| 'coverage (y/n)', 'n', boolean) |
| if 'ext_pngmath' not in d: |
| do_prompt(d, 'ext_pngmath', 'pngmath: include math, rendered ' |
| 'as PNG images (y/n)', 'n', boolean) |
| if 'ext_mathjax' not in d: |
| do_prompt(d, 'ext_mathjax', 'mathjax: include math, rendered in the ' |
| 'browser by MathJax (y/n)', 'n', boolean) |
| if d['ext_pngmath'] and d['ext_mathjax']: |
| print('''Note: pngmath and mathjax cannot be enabled at the same time. |
| pngmath has been deselected.''') |
| d['ext_pngmath'] = False |
| if 'ext_ifconfig' not in d: |
| do_prompt(d, 'ext_ifconfig', 'ifconfig: conditional inclusion of ' |
| 'content based on config values (y/n)', 'n', boolean) |
| if 'ext_viewcode' not in d: |
| do_prompt(d, 'ext_viewcode', 'viewcode: include links to the source ' |
| 'code of documented Python objects (y/n)', 'n', boolean) |
| |
| if 'makefile' not in d: |
| print(''' |
| 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.''') |
| do_prompt(d, 'makefile', 'Create Makefile? (y/n)', 'y', boolean) |
| if 'batchfile' not in d: |
| do_prompt(d, 'batchfile', 'Create Windows command file? (y/n)', |
| 'y', boolean) |
| print() |
| |
| |
| def generate(d, overwrite=True, silent=False): |
| """Generate project based on values in *d*.""" |
| |
| texescape.init() |
| indent = ' ' * 4 |
| |
| if 'mastertoctree' not in d: |
| d['mastertoctree'] = '' |
| if 'mastertocmaxdepth' not in d: |
| d['mastertocmaxdepth'] = 2 |
| |
| d['project_fn'] = make_filename(d['project']) |
| d['project_manpage'] = d['project_fn'].lower() |
| d['now'] = time.asctime() |
| d['project_underline'] = column_width(d['project']) * '=' |
| extensions = (',\n' + indent).join( |
| repr('sphinx.ext.' + name) |
| for name in ('autodoc', 'doctest', 'intersphinx', 'todo', 'coverage', |
| 'pngmath', 'mathjax', 'ifconfig', 'viewcode') |
| if d.get('ext_' + name)) |
| if extensions: |
| d['extensions'] = '\n' + indent + extensions + ',\n' |
| else: |
| d['extensions'] = extensions |
| d['copyright'] = time.strftime('%Y') + ', ' + d['author'] |
| d['author_texescaped'] = text_type(d['author']).\ |
| translate(texescape.tex_escape_map) |
| d['project_doc'] = d['project'] + ' Documentation' |
| d['project_doc_texescaped'] = text_type(d['project'] + ' Documentation').\ |
| translate(texescape.tex_escape_map) |
| |
| # escape backslashes and single quotes in strings that are put into |
| # a Python string literal |
| for key in ('project', 'project_doc', 'project_doc_texescaped', |
| 'author', 'author_texescaped', 'copyright', |
| 'version', 'release', 'master'): |
| d[key + '_str'] = d[key].replace('\\', '\\\\').replace("'", "\\'") |
| |
| if not path.isdir(d['path']): |
| mkdir_p(d['path']) |
| |
| srcdir = d['sep'] and path.join(d['path'], 'source') or d['path'] |
| |
| mkdir_p(srcdir) |
| if d['sep']: |
| builddir = path.join(d['path'], 'build') |
| d['exclude_patterns'] = '' |
| else: |
| builddir = path.join(srcdir, d['dot'] + 'build') |
| d['exclude_patterns'] = repr(d['dot'] + 'build') |
| mkdir_p(builddir) |
| mkdir_p(path.join(srcdir, d['dot'] + 'templates')) |
| mkdir_p(path.join(srcdir, d['dot'] + 'static')) |
| |
| def write_file(fpath, content, newline=None): |
| if overwrite or not path.isfile(fpath): |
| print('Creating file %s.' % fpath) |
| f = open(fpath, 'wt', encoding='utf-8', newline=newline) |
| try: |
| f.write(content) |
| finally: |
| f.close() |
| else: |
| print('File %s already exists, skipping.' % fpath) |
| |
| conf_text = QUICKSTART_CONF % d |
| if d['epub']: |
| conf_text += EPUB_CONFIG % d |
| if d.get('ext_intersphinx'): |
| conf_text += INTERSPHINX_CONFIG |
| |
| write_file(path.join(srcdir, 'conf.py'), conf_text) |
| |
| masterfile = path.join(srcdir, d['master'] + d['suffix']) |
| write_file(masterfile, MASTER_FILE % d) |
| |
| if d['makefile']: |
| d['rsrcdir'] = d['sep'] and 'source' or '.' |
| d['rbuilddir'] = d['sep'] and 'build' or d['dot'] + 'build' |
| # use binary mode, to avoid writing \r\n on Windows |
| write_file(path.join(d['path'], 'Makefile'), MAKEFILE % d, u'\n') |
| |
| if d['batchfile']: |
| d['rsrcdir'] = d['sep'] and 'source' or '.' |
| d['rbuilddir'] = d['sep'] and 'build' or d['dot'] + 'build' |
| write_file(path.join(d['path'], 'make.bat'), BATCHFILE % d, u'\r\n') |
| |
| if silent: |
| return |
| print() |
| print(bold('Finished: An initial directory structure has been created.')) |
| print(''' |
| You should now populate your master file %s and create other documentation |
| source files. ''' % masterfile + ((d['makefile'] or d['batchfile']) and '''\ |
| Use the Makefile to build the docs, like so: |
| make builder |
| ''' or '''\ |
| Use the sphinx-build command to build the docs, like so: |
| sphinx-build -b builder %s %s |
| ''' % (srcdir, builddir)) + '''\ |
| where "builder" is one of the supported builders, e.g. html, latex or linkcheck. |
| ''') |
| |
| |
| def main(argv=sys.argv): |
| if not color_terminal(): |
| nocolor() |
| |
| d = {} |
| if len(argv) > 3: |
| print('Usage: sphinx-quickstart [root]') |
| sys.exit(1) |
| elif len(argv) == 2: |
| d['path'] = argv[1] |
| try: |
| ask_user(d) |
| except (KeyboardInterrupt, EOFError): |
| print() |
| print('[Interrupted.]') |
| return |
| generate(d) |
| |
| |
| if __name__ == '__main__': |
| sys.exit(main(sys.argv)) |