docs/_themes/sphinx_rtd_theme/breadcrumbs.html

   1 {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
   2
   3 {% if page_source_suffix %}
   4 {% set suffix = page_source_suffix %}
   5 {% else %}
   6 {% set suffix = source_suffix %}
   7 {% endif %}
   8
   9 {% if meta is defined and meta is not none %}
  10 {% set check_meta = True %}
  11 {% else %}
  12 {% set check_meta = False %}
  13 {% endif %}
  14
  15 {% if check_meta and 'github_url' in meta %}
  16 {% set display_github = True %}
  17 {% endif %}
  18
  19 {% if check_meta and 'bitbucket_url' in meta %}
  20 {% set display_bitbucket = True %}
  21 {% endif %}
  22
  23 {% if check_meta and 'gitlab_url' in meta %}
  24 {% set display_gitlab = True %}
  25 {% endif %}
  26
  27 <div role="navigation" aria-label="breadcrumbs navigation">
  28
  29   <ul class="wy-breadcrumbs">
  30     {% block breadcrumbs %}
  31       <li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
  32         {% for doc in parents %}
  33           <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
  34         {% endfor %}
  35       <li>{{ title }}</li>
  36     {% endblock %}
  37     {% block breadcrumbs_aside %}
  38       <li class="wy-breadcrumbs-aside">
  39         {% if hasdoc(pagename) %}
  40             {% if display_github %}
  41             {% if check_meta and 'github_url' in meta %}
  42               <!-- User defined GitHub URL -->
  43               <a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
  44             {% else %}
  45               <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
  46             {% endif %}
  47           {% elif display_bitbucket %}
  48             {% if check_meta and 'bitbucket_url' in meta %}
  49               <!-- User defined Bitbucket URL -->
  50               <a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
  51             {% else %}
  52               <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
  53             {% endif %}
  54           {% elif display_gitlab %}
  55             {% if check_meta and 'gitlab_url' in meta %}
  56               <!-- User defined GitLab URL -->
  57               <a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
  58             {% else %}
  59               <a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/blob/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
  60             {% endif %}
  61           {% elif show_source and source_url_prefix %}
  62             <a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
  63           {% elif show_source and has_source and sourcename %}
  64             <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
  65           {% endif %}
  66         {% endif %}
  67       </li>
  68     {% endblock %}
  69   </ul>
  70
  71   {% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
  72   <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
  73       {% if next %}
  74         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
  75       {% endif %}
  76       {% if prev %}
  77         <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  78       {% endif %}
  79   </div>
  80   {% endif %}
  81   <hr/>
  82 </div>