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

# 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

# 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

# Output file base name for HTML help builder.

htmlhelp_basename = 'Kallithea-docs'

# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').

#latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').

#latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title, author, documentclass [howto/manual]).

latex_documents = [

  ('index', 'Kallithea.tex', u'Kallithea Documentation',

   u'Kallithea Developers', '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

# Additional stuff for the LaTeX preamble.

#latex_preamble = ''

# 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 = [

    ('index', 'kallithea', u'Kallithea Documentation',

     [u'Kallithea Developers'], 1)

]

# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {'http://docs.python.org/': None}

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

<%inherit file="root.html"/>

<!-- HEADER -->

<div id="header">

    <div id="header-inner" class="title">

        <div id="logo">

          <a href="${h.url('home')}" style="display: block;">

            <div class="header">

                <img src="${h.url('/images/kallithea-logo.svg')}" onerror="this.onerror='';this.src='${h.url('/images/kallithea-logo.png')}'" alt="Kallithea"/>

            </div>

            %if c.site_name:

             <div class="branding">${c.site_name}</div>

            %endif

          </a>

        </div>

        <!-- MENU -->

        ${self.page_nav()}

        <!-- END MENU -->

        ${self.body()}

    </div>

</div>

<!-- END HEADER -->

<!-- CONTENT -->

<div id="content">

    ${self.flash_msg()}

    <div id="main">

        ${next.main()}

    </div>

</div>

<!-- END CONTENT -->

<!-- FOOTER -->

<div id="footer">

   <div id="footer-inner" class="title">

       <div>

           <p class="footer-link">

               ${_('Server instance: %s') % c.instance_id if c.instance_id else ''}

           </p>

           <p class="footer-link-right">

               This site is powered by

               %if c.visual.show_version:

                   <a href="${h.url('kallithea_project_url')}" target="_blank">Kallithea</a> ${c.kallithea_version},

               %else:

                   <a href="${h.url('kallithea_project_url')}" target="_blank">Kallithea</a>,

               %endif

               which is

               %if c.issues_url:

                   &ndash; <a href="${c.issues_url}" target="_blank">${_('Support')}</a>

               %endif

           </p>

       </div>

   </div>

</div>

<!-- END FOOTER -->

### MAKO DEFS ###

<%def name="flash_msg()">

    <%include file="/base/flash_msg.html"/>

</%def>

<%def name="breadcrumbs()">

    <div class="breadcrumbs">

    ${self.breadcrumbs_links()}

    </div>

</%def>

<%def name="admin_menu()">

  <ul class="admin_menu">

      <li><a href="${h.url('admin_home')}"><i class="icon-book"></i> ${_('Admin Journal')}</a></li>

      <li><a href="${h.url('repos')}"><i class="icon-database"></i> ${_('Repositories')}</a></li>

      <li><a href="${h.url('repos_groups')}"><i class="icon-folder"></i> ${_('Repository Groups')}</a></li>

      <li><a href="${h.url('users')}"><i class="icon-user"></i> ${_('Users')}</a></li>

      <li><a href="${h.url('users_groups')}"><i class="icon-users"></i> ${_('User Groups')}</a></li>

      <li><a href="${h.url('admin_permissions')}"><i class="icon-block"></i> ${_('Permissions')}</a></li>

      <li><a href="${h.url('auth_home')}"><i class="icon-key"></i> ${_('Authentication')}</a></li>

      <li><a href="${h.url('defaults')}"><i class="icon-wrench"></i> ${_('Defaults')}</a></li>

      <li class="last"><a href="${h.url('admin_settings')}"><i class="icon-gear"></i> ${_('Settings')}</a></li>

  </ul>

</%def>

## admin menu used for people that have some admin resources

<%def name="admin_menu_simple(repositories=None, repository_groups=None, user_groups=None)">

  <ul>

   %if repositories:

      <li><a href="${h.url('repos')}"><i class="icon-database"></i> ${_('Repositories')}</a></li>

   %endif

   %if repository_groups:

      <li><a href="${h.url('repos_groups')}"><i class="icon-folder"></i> ${_('Repository Groups')}</a></li>

   %endif

   %if user_groups:

      <li><a href="${h.url('users_groups')}"><i class="icon-users"></i> ${_('User Groups')}</a></li>

   %endif

  </ul>

</%def>

<%def name="repo_context_bar(current=None, rev=None)">

  <% rev = None if rev == 'tip' else rev %>

  <%

      def follow_class():

          if c.repository_following:

              return h.literal('following')

          else:

              return h.literal('follow')

  %>

  <%

    def is_current(selected):

        if selected == current:

            return h.literal('class="current"')

    %>

  <!--- CONTEXT BAR -->

  <div id="context-bar" class="box">

      <h2>

        %if h.is_hg(c.db_repo):

          <i class="icon-hg" style="color: #576622; font-size: 24px"></i>

        %endif

        %if h.is_git(c.db_repo):

          <i class="icon-git" style="color: #e85634; font-size: 24px"></i>

        %endif

        ## public/private

        %if c.db_repo.private:

          <i class="icon-keyhole-circled"></i>

        %else:

          <i class="icon-globe"></i>

        %endif

        ${h.repo_link(c.db_repo.groups_and_repo)}

        %if current == 'createfork':

         - ${_('Create Fork')}

        %endif

      </h2>

      <!--

      <div id="breadcrumbs">

        ${h.link_to(_(u'Repositories'),h.url('home'))}

        »

        ${h.repo_link(c.db_repo.groups_and_repo)}

      </div>

      -->

      <ul id="context-pages" class="horizontal-list">

        <li ${is_current('summary')}><a href="${h.url('summary_home', repo_name=c.repo_name)}"><i class="icon-file-text"></i> ${_('Summary')}</a></li>

        %if rev:

        <li ${is_current('changelog')}><a href="${h.url('changelog_file_home', repo_name=c.repo_name, revision=rev, f_path='')}"><i class="icon-clock"></i> ${_('Changelog')}</a></li>

        %else:

        <li ${is_current('changelog')}><a href="${h.url('changelog_home', repo_name=c.repo_name)}"><i class="icon-clock"></i> ${_('Changelog')}</a></li>

        %endif

        <li ${is_current('files')}><a href="${h.url('files_home', repo_name=c.repo_name, revision=rev or 'tip')}"><i class="icon-doc-inv"></i> ${_('Files')}</a></li>

        <li ${is_current('switch-to')}>

          <a href="#" id="branch_tag_switcher_2" class="dropdown"><i class="icon-exchange"></i> ${_('Switch To')}</a>

          <ul id="switch_to_list_2" class="switch_to submenu">

            <li><a href="#">${_('Loading...')}</a></li>

          </ul>

        </li>

        <li ${is_current('options')}>

             %if h.HasRepoPermissionAll('repository.admin')(c.repo_name):

               <a href="${h.url('edit_repo',repo_name=c.repo_name)}" class="dropdown"><i class="icon-wrench"></i> ${_('Options')}</a>

             %else:

               <a href="#" class="dropdown"><i class="icon-wrench"></i> ${_('Options')}</a>

             %endif

          <ul>

             %if h.HasRepoPermissionAll('repository.admin')(c.repo_name):

                   <li><a href="${h.url('edit_repo',repo_name=c.repo_name)}"><i class="icon-gear"></i> ${_('Settings')}</a></li>

             %endif

              %if c.db_repo.fork:

               <li><a href="${h.url('compare_url',repo_name=c.db_repo.fork.repo_name,org_ref_type=c.db_repo.landing_rev[0],org_ref_name=c.db_repo.landing_rev[1], other_repo=c.repo_name,other_ref_type='branch' if request.GET.get('branch') else c.db_repo.landing_rev[0],other_ref_name=request.GET.get('branch') or c.db_repo.landing_rev[1], merge=1)}">

                   <i class="icon-git-compare"></i> ${_('Compare Fork')}</a></li>

              %endif

              <li><a href="${h.url('compare_home',repo_name=c.repo_name)}"><i class="icon-git-compare"></i> ${_('Compare')}</a></li>

              <li><a href="${h.url('search_repo',repo_name=c.repo_name)}"><i class="icon-search"></i> ${_('Search')}</a></li>

              %if h.HasRepoPermissionAny('repository.write','repository.admin')(c.repo_name) and c.db_repo.enable_locking:

                %if c.db_repo.locked[0]:

                  <li>${h.link_to(_('Unlock'), h.url('toggle_locking',repo_name=c.repo_name),class_='locking_del')}</li>

                %else:

                  <li>${h.link_to(_('Lock'), h.url('toggle_locking',repo_name=c.repo_name),class_='locking_add')}</li>

                %endif

              %endif

              ## TODO: this check feels wrong, it would be better to have a check for permissions

              ## also it feels like a job for the controller

              %if c.authuser.username != 'default':

                  <li>

                   <a class="${follow_class()}" onclick="javascript:toggleFollowingRepo(this,${c.db_repo.repo_id},'${str(h.get_token())}');">

                    <span class="show-follow"><i class="icon-heart-empty"></i> ${_('Follow')}</span>

                    <span class="show-following"><i class="icon-heart"></i> ${_('Unfollow')}</span>

                  </a>

                  </li>

                  <li><a href="${h.url('repo_fork_home',repo_name=c.repo_name)}"><i class="icon-git-pull-request"></i> ${_('Fork')}</a></li>

                  <li><a href="${h.url('pullrequest_home',repo_name=c.repo_name)}"><i class="icon-git-pull-request"></i> ${_('Create Pull Request')}</a></li>

              %endif

             </ul>

        </li>

        <li ${is_current('showpullrequest')}>

          <a href="${h.url('pullrequest_show_all',repo_name=c.repo_name)}" title="${_('Show Pull Requests for %s') % c.repo_name}"> <i class="icon-git-pull-request"></i> ${_('Pull Requests')}

            %if c.repository_pull_requests:

              <span>${c.repository_pull_requests}</span>

            %endif

          </a>

        </li>

      </ul>

  </div>

  <script type="text/javascript">

      YUE.on('branch_tag_switcher_2','mouseover',function(){

         var $branch_tag_switcher_2 = $('#branch_tag_switcher_2');

         var loaded = $branch_tag_switcher_2.hasClass('loaded');

         if(!loaded){

             $branch_tag_switcher_2.addClass('loaded');

             asynchtml("${h.url('branch_tag_switcher',repo_name=c.repo_name)}", $('#switch_to_list_2'));

         }

         return false;

      });

  </script>

  <!--- END CONTEXT BAR -->

</%def>

<%def name="menu(current=None)">

  <%

  def is_current(selected):

      if selected == current:

          return h.literal('class="current"')

  %>

  <ul id="quick" class="horizontal-list">

    <!-- repo switcher -->

    <li ${is_current('repositories')}>

      <input id="repo_switcher" name="repo_switcher" type="hidden">

    </li>

    ##ROOT MENU

    %if c.authuser.username != 'default':

      <li ${is_current('journal')}>

        <a class="menu_link" title="${_('Show recent activity')}"  href="${h.url('journal')}">

          <i class="icon-book"></i> ${_('Journal')}

        </a>

      </li>

    %else:

      <li ${is_current('journal')}>

        <a class="menu_link" title="${_('Public journal')}"  href="${h.url('public_journal')}">

          <i class="icon-book"></i> ${_('Public journal')}

        </a>

      </li>

    %endif

      <li ${is_current('gists')}>

        <a class="menu_link childs" title="${_('Show public gists')}"  href="${h.url('gists')}">

          <i class="icon-clippy"></i> ${_('Gists')}

        </a>

          <ul class="admin_menu">

            <li><a href="${h.url('new_gist', public=1)}"><i class="icon-paste"></i> ${_('Create New Gist')}</a></li>

            <li><a href="${h.url('gists')}"><i class="icon-globe"></i> ${_('All Public Gists')}</a></li>

            %if c.authuser.username != 'default':

              <li><a href="${h.url('gists', public=1)}"><i class="icon-user"></i> ${_('My Public Gists')}</a></li>

              <li><a href="${h.url('gists', private=1)}"><i class="icon-keyhole-circled"></i> ${_('My Private Gists')}</a></li>

            %endif

          </ul>

      </li>

    <li ${is_current('search')}>

        <a class="menu_link" title="${_('Search in repositories')}"  href="${h.url('search')}">

          <i class="icon-search"></i> ${_('Search')}

        </a>

    </li>

    % if h.HasPermissionAll('hg.admin')('access admin main page'):

      <li ${is_current('admin')}>

        <a class="menu_link childs" title="${_('Admin')}" href="${h.url('admin_home')}">

          <i class="icon-gear"></i> ${_('Admin')}

        </a>

        ${admin_menu()}

      </li>

    % elif c.authuser.repositories_admin or c.authuser.repository_groups_admin or c.authuser.user_groups_admin:

    <li ${is_current('admin')}>

        <a class="menu_link childs" title="${_('Admin')}">

          <i class="icon-gear"></i> ${_('Admin')}

        </a>

        ${admin_menu_simple(c.authuser.repositories_admin,

                            c.authuser.repository_groups_admin,

                            c.authuser.user_groups_admin or h.HasPermissionAny('hg.usergroup.create.true')())}

    </li>

    % endif

    <li ${is_current('my_pullrequests')}>

      <a class="menu_link" title="${_('My Pull Requests')}" href="${h.url('my_pullrequests')}">

        <i class="icon-git-pull-request"></i> ${_('My Pull Requests')}

        %if c.my_pr_count != 0:

          <span class="menu_link_notifications">${c.my_pr_count}</span>

        %endif

      </a>

    </li>

    ## USER MENU

    <li>

      <a class="menu_link childs" id="quick_login_link">

          <span class="icon">

             <img src="${h.gravatar_url(c.authuser.email,20)}" alt="avatar">

          </span>

          %if c.authuser.username != 'default':

            <span class="menu_link_user">${c.authuser.username}</span>

            %if c.unread_notifications != 0:

              <span class="menu_link_notifications">${c.unread_notifications}</span>

            %endif

          %else:

              <span>${_('Not Logged In')}</span>

          %endif

      </a>

      <div class="user-menu">

        <div id="quick_login">

          %if c.authuser.username == 'default' or c.authuser.user_id is None:

            <h4>${_('Login to Your Account')}</h4>

            ${h.form(h.url('login_home',came_from=h.url.current()))}

            <div class="form">

                <div class="fields">

                    <div class="field">

                        <div class="label">

                            <label for="username">${_('Username')}:</label>

                        </div>

                        <div class="input">

                            ${h.text('username',class_='focus')}

                        </div>

                    </div>

                    <div class="field">

                        <div class="label">

                            <label for="password">${_('Password')}:</label>

                        </div>

                        <div class="input">

                            ${h.password('password',class_='focus')}

                        </div>

                    </div>

                    <div class="buttons">

                        <div class="password_forgoten">${h.link_to(_('Forgot password ?'),h.url('reset_password'))}</div>

                        <div class="register">

                        %if h.HasPermissionAny('hg.admin', 'hg.register.auto_activate', 'hg.register.manual_activate')():

                         ${h.link_to(_("Don't have an account ?"),h.url('register'))}

                        %endif

                        </div>

                        <div class="submit">

                            ${h.submit('sign_in',_('Log In'),class_="btn btn-mini")}

                        </div>

                    </div>

                </div>

            </div>

            ${h.end_form()}

          %else:

            <div class="links_left">

                <div class="big_gravatar"><img alt="gravatar" src="${h.gravatar_url(c.authuser.email,48)}" /></div>

                <div class="full_name">${c.authuser.full_name_or_username}</div>

                <div class="email">${c.authuser.email}</div>

            </div>

            <div class="links_right">

            <ol class="links">

              <li><a href="${h.url('notifications')}">${_('Notifications')}: ${c.unread_notifications}</a></li>

              <li>${h.link_to(_(u'My Account'),h.url('my_account'))}</li>

              <li class="logout">${h.link_to(_(u'Log Out'),h.url('logout_home'))}</li>

            </ol>

            </div>

          %endif

        </div>

      </div>

    </li>

    <script type="text/javascript">

        var visual_show_public_icon = "${c.visual.show_public_icon}" == "True";

        var cache = {}

        /*format the look of items in the list*/

        var format = function(state){

            if (!state.id){

              return state.text; // optgroup

            }

            var obj_dict = state.obj;

            var tmpl = '';

            if(obj_dict && state.type == 'repo'){

                tmpl += '<span class="repo-icons">';

                if(obj_dict['repo_type'] === 'hg'){

                    tmpl += '<i class="icon-hg"></i> ';

                }

                else if(obj_dict['repo_type'] === 'git'){

                    tmpl += '<i class="icon-git"></i> ';

                }

                if(obj_dict['private']){

                    tmpl += '<i class="icon-keyhole-circled"></i> ';

                }

                else if(visual_show_public_icon){

                    tmpl += '<i class="icon-globe"></i> ';

                }

                tmpl += '</span>';

            }

            if(obj_dict && state.type == 'group'){

                    tmpl += '<i class="icon-folder"></i> ';

            }

            tmpl += state.text;

            return tmpl;

        }

        $("#repo_switcher").select2({

            placeholder: '<i class="icon-database"></i> ${_('Repositories')}',

            dropdownAutoWidth: true,

            formatResult: format,

            formatSelection: format,

            formatNoMatches: function(term){

                return "${_('No matches found')}";

            },

            containerCssClass: "repo-switcher",

            dropdownCssClass: "repo-switcher-dropdown",

            escapeMarkup: function(m){

                // don't escape our custom placeholder

                if(m.substr(0,29) == '<i class="icon-database"></i>'){

                    return m;

                }

                return Select2.util.escapeMarkup(m);

            },

            query: function(query){

              var key = 'cache';

              var cached = cache[key] ;

              if(cached) {

                var data = {results: []};

                //filter results

                $.each(cached.results, function(){

                    var section = this.text;

                    var children = [];

                    $.each(this.children, function(){

                        if(query.term.length == 0 || this.text.toUpperCase().indexOf(query.term.toUpperCase()) >= 0 ){

                            children.push({'id': this.id, 'text': this.text, 'type': this.type, 'obj': this.obj})

                        }

                    })