# -*- coding: utf-8 -*-

#

# Kallithea documentation build configuration file, created by

# sphinx-quickstart on Sun Oct 10 16:46:37 2010.

#

# 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 = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',

              'sphinx.ext.intersphinx', 'sphinx.ext.todo',

              'sphinx.ext.viewcode']

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix of source filenames.

source_suffix = '.rst'

# The encoding of source files.

#source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = u'Kallithea'

# 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.

root = os.path.dirname(os.path.dirname(__file__))

sys.path.append(root)

from kallithea import __version__

version = __version__

# The full version, including alpha/beta/rc tags.

release = __version__

# 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 = ['_build']

# 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'

highlight_language = 'none'

# A list of ignored prefixes for module index sorting.

#modindex_common_prefix = []

# -- 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 = 'nature'

# 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 = ['theme']

# 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 = ['_static']

# 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

    """Convert a list of years into brief range like '1900-1901, 1921'."""

    if not l:

        return ''

    start = end = int(l[0])

    ranges = []

    for year in l[1:] + [0]:

        year = int(year)

        if year == end + 1:

            end = year

            continue

        if start == end:

            ranges.append('%s' % start)

        else:

            ranges.append('%s%s%s' % (start, dash, end))

        start = end = year

    assert start == 0 and end == 0, (start, end)

    return join.join(ranges)

def insert_entries(

        filename,

        all_entries,

        no_entries,

        domain_extra,

        split_re,

        normalize_name,

        format_f):

    """Update file with contributor information.

    all_entries: list of tuples with year and name

    no_entries: set of names or name and year tuples to ignore

    domain_extra: map domain name to extra credit name

    split_re: regexp matching the part of file to rewrite

    normalize_name: function to normalize names for grouping and display

    format_f: function formatting year list and name to a string

    """

    name_years = defaultdict(set)

    for year, name in all_entries:

        if name in no_entries or (name, year) in no_entries:

            continue

        domain = name.split('@', 1)[-1].rstrip('>')

        if domain in domain_extra:

            name_years[domain_extra[domain]].add(year)

        name_years[normalize_name(name)].add(year)

    l = [(list(sorted(year for year in years if year)), name)

         for name, years in name_years.items()]

    l.sort(key=sortkey)

    with open(filename) as f:

        pre, post = re.split(split_re, f.read())

    with open(filename, 'w') as f:

        f.write(pre +

                ''.join(format_f(years, name) for years, name in l) +

                post)

def main():

    repo_entries = [

        (year, contributor_data.name_fixes.get(name) or contributor_data.name_fixes.get(name.rsplit('<', 1)[0].strip()) or name)

        for year, name in

        (line.strip().split(' ', 1)

         for line in os.popen("""hg log -r '::.' -T '{date(date,"%Y")} {author}\n'""").readlines())

        ]

    insert_entries(

        filename='kallithea/templates/about.html',

        all_entries=repo_entries + contributor_data.other_about + contributor_data.other,

        no_entries=contributor_data.no_about,

        domain_extra=contributor_data.domain_extra,

        split_re=r'(?:  <li>Copyright &copy; [^\n]*</li>\n)*',

        normalize_name=lambda name: name.split('<', 1)[0].strip(),

        format_f=lambda years, name: '  <li>Copyright &copy; %s, %s</li>\n' % (nice_years(years, '&ndash;', ', '), name),

        )

    insert_entries(

        filename='CONTRIBUTORS',

        all_entries=repo_entries + contributor_data.other_contributors + contributor_data.other,

        no_entries=contributor_data.total_ignore,

        domain_extra=contributor_data.domain_extra,

        split_re=r'(?:    [^\n]*\n)*',

        normalize_name=lambda name: name,

        format_f=lambda years, name: ('    %s%s%s\n' % (name, ' ' if years else '', nice_years(years))),

        )

    insert_entries(

        filename='kallithea/templates/base/base.html',

        all_entries=repo_entries,

        no_entries=contributor_data.total_ignore,

        domain_extra={},

        split_re=r'(?<=&copy;) .* (?=by various authors)',

        normalize_name=lambda name: '',

        format_f=lambda years, name: ' ' + nice_years(years, '–', ', ') + ' ',

        )

if __name__ == '__main__':

    main()

# To list new contributors since last tagging:

# { hg log -r '::tagged()' -T '    {author}\n    {author}\n'; hg log -r '::.' -T '    {author}\n' | sort | uniq; } | sort | uniq -u