EVOLUTION-MANAGER

Edit File: changes.py

# -*- coding: utf-8 -*-
"""
    sphinx.builders.changes
    ~~~~~~~~~~~~~~~~~~~~~~~

Changelog builder.

:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import codecs
from os import path
from typing import cast

from six import iteritems

from sphinx import package_dir
from sphinx.builders import Builder
from sphinx.domains.changeset import ChangeSetDomain
from sphinx.locale import _, __
from sphinx.theming import HTMLThemeFactory
from sphinx.util import logging
from sphinx.util.console import bold  # type: ignore
from sphinx.util.fileutil import copy_asset_file
from sphinx.util.osutil import ensuredir, os_path
from sphinx.util.pycompat import htmlescape

if False:
    # For type annotation
    from typing import Any, Dict, List, Tuple  # NOQA
    from sphinx.application import Sphinx  # NOQA

logger = logging.getLogger(__name__)

class ChangesBuilder(Builder):
    """
    Write a summary with all versionadded/changed directives.
    """
    name = 'changes'
    epilog = __('The overview file is in %(outdir)s.')

def init(self):
        # type: () -> None
        self.create_template_bridge()
        theme_factory = HTMLThemeFactory(self.app)
        self.theme = theme_factory.create('default')
        self.templates.init(self, self.theme)

def get_outdated_docs(self):
        # type: () -> unicode
        return self.outdir

typemap = {
        'versionadded': 'added',
        'versionchanged': 'changed',
        'deprecated': 'deprecated',
    }  # type: Dict[unicode, unicode]

def write(self, *ignored):
 # type: (Any) -> None
 version = self.config.version
 domain = cast(ChangeSetDomain, self.env.get_domain('changeset'))
 libchanges = {} # type: Dict[unicode, List[Tuple[unicode, unicode, int]]]
 apichanges = [] # type: List[Tuple[unicode, unicode, int]]
 otherchanges = {} # type: Dict[Tuple[unicode, unicode], List[Tuple[unicode, unicode, int]]] # NOQA
 if version not in self.env.versionchanges:
 logger.info(bold(__('no changes in version %s.') % version))
 return
 logger.info(bold('writing summary file...'))
 for changeset in domain.get_changesets_for(version):
 if isinstance(changeset.descname, tuple):
 descname = changeset.descname[0]
 else:
 descname = changeset.descname
 ttext = self.typemap[changeset.type]
 context = changeset.content.replace('\n', ' ')
 if descname and changeset.docname.startswith('c-api'):
 if context:
 entry = '%s: %s: %s' % (descname, ttext,
 context)
 else:
 entry = '%s: %s.' % (descname, ttext)
 apichanges.append((entry, changeset.docname, changeset.lineno))
 elif descname or changeset.module:
 module = changeset.module or _('Builtins')
 if not descname:
 descname = _('Module level')
 if context:
 entry = '%s: %s: %s' % (descname, ttext,
 context)
 else:
 entry = '%s: %s.' % (descname, ttext)
 libchanges.setdefault(module, []).append((entry, changeset.docname,
 changeset.lineno))
 else:
 if not context:
 continue
 entry = '%s: %s' % (ttext.capitalize(), context)
 title = self.env.titles[changeset.docname].astext()
 otherchanges.setdefault((changeset.docname, title), []).append(
 (entry, changeset.docname, changeset.lineno))

ctx = {
            'project': self.config.project,
            'version': version,
            'docstitle': self.config.html_title,
            'shorttitle': self.config.html_short_title,
            'libchanges': sorted(iteritems(libchanges)),
            'apichanges': sorted(apichanges),
            'otherchanges': sorted(iteritems(otherchanges)),
            'show_copyright': self.config.html_show_copyright,
            'show_sphinx': self.config.html_show_sphinx,
        }
        with codecs.open(path.join(self.outdir, 'index.html'), 'w', 'utf8') as f:  # type: ignore  # NOQA
            f.write(self.templates.render('changes/frameset.html', ctx))
        with codecs.open(path.join(self.outdir, 'changes.html'), 'w', 'utf8') as f:  # type: ignore  # NOQA
            f.write(self.templates.render('changes/versionchanges.html', ctx))

hltext = ['.. versionadded:: %s' % version,
                  '.. versionchanged:: %s' % version,
                  '.. deprecated:: %s' % version]

def hl(no, line):
 # type: (int, unicode) -> unicode
 line = '<a name="L%s"> </a>' % no + htmlescape(line)
 for x in hltext:
 if x in line:
 line = '%s' % line
 break
 return line

logger.info(bold(__('copying source files...')))
        for docname in self.env.all_docs:
            with codecs.open(self.env.doc2path(docname), 'r',  # type: ignore
                             self.env.config.source_encoding) as f:
                try:
                    lines = f.readlines()
                except UnicodeDecodeError:
                    logger.warning(__('could not read %r for changelog creation'), docname)
                    continue
            targetfn = path.join(self.outdir, 'rst', os_path(docname)) + '.html'
            ensuredir(path.dirname(targetfn))
            with codecs.open(targetfn, 'w', 'utf-8') as f:  # type: ignore
                text = ''.join(hl(i + 1, line) for (i, line) in enumerate(lines))
                ctx = {
                    'filename': self.env.doc2path(docname, None),
                    'text': text
                }
                f.write(self.templates.render('changes/rstsource.html', ctx))
        themectx = dict(('theme_' + key, val) for (key, val) in
                        iteritems(self.theme.get_options({})))
        copy_asset_file(path.join(package_dir, 'themes', 'default', 'static', 'default.css_t'),
                        self.outdir, context=themectx, renderer=self.templates)
        copy_asset_file(path.join(package_dir, 'themes', 'basic', 'static', 'basic.css'),
                        self.outdir)

def hl(self, text, version):
 # type: (unicode, unicode) -> unicode
 text = htmlescape(text)
 for directive in ['versionchanged', 'versionadded', 'deprecated']:
 text = text.replace('.. %s:: %s' % (directive, version),
 '.. %s:: %s' % (directive, version))
 return text

def finish(self):
        # type: () -> None
        pass

def setup(app):
    # type: (Sphinx) -> Dict[unicode, Any]
    app.add_builder(ChangesBuilder)

return {
        'version': 'builtin',
        'parallel_read_safe': True,
        'parallel_write_safe': True,
    }