forked from nghttp2/nghttp2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
32ac8bd
commit 4272dca
Showing
67 changed files
with
4,798 additions
and
1,041 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,34 @@ | ||
"""Sphinx ReadTheDocs theme. | ||
""" | ||
Sphinx Read the Docs theme. | ||
From https://github.com/ryan-roemer/sphinx-bootstrap-theme. | ||
""" | ||
import os | ||
|
||
VERSION = (0, 1, 9) | ||
from os import path | ||
|
||
import sphinx | ||
|
||
|
||
__version__ = ".".join(str(v) for v in VERSION) | ||
__version__ = '0.5.0' | ||
__version_full__ = __version__ | ||
|
||
|
||
def get_html_theme_path(): | ||
"""Return list of HTML theme paths.""" | ||
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) | ||
cur_dir = path.abspath(path.dirname(path.dirname(__file__))) | ||
return cur_dir | ||
|
||
|
||
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package | ||
def setup(app): | ||
if sphinx.version_info >= (1, 6, 0): | ||
# Register the theme that can be referenced without adding a theme path | ||
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) | ||
|
||
if sphinx.version_info >= (1, 8, 0): | ||
# Add Sphinx message catalog for newer versions of Sphinx | ||
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog | ||
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') | ||
app.add_message_catalog('sphinx', rtd_locale_path) | ||
|
||
return {'parallel_read_safe': True, 'parallel_write_safe': True} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,84 @@ | ||
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} | ||
|
||
{% if page_source_suffix %} | ||
{% if page_source_suffix %} | ||
{% set suffix = page_source_suffix %} | ||
{% else %} | ||
{% set suffix = source_suffix %} | ||
{% endif %} | ||
|
||
{% if meta is defined and meta is not none %} | ||
{% set check_meta = True %} | ||
{% else %} | ||
{% set check_meta = False %} | ||
{% endif %} | ||
|
||
{% if check_meta and 'github_url' in meta %} | ||
{% set display_github = True %} | ||
{% endif %} | ||
|
||
{% if check_meta and 'bitbucket_url' in meta %} | ||
{% set display_bitbucket = True %} | ||
{% endif %} | ||
|
||
{% if check_meta and 'gitlab_url' in meta %} | ||
{% set display_gitlab = True %} | ||
{% endif %} | ||
|
||
{% set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %} | ||
|
||
<div role="navigation" aria-label="breadcrumbs navigation"> | ||
|
||
<ul class="wy-breadcrumbs"> | ||
<li><a href="{{ pathto(master_doc) }}">Docs</a> »</li> | ||
{% for doc in parents %} | ||
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> | ||
{% endfor %} | ||
<li>{{ title }}</li> | ||
<li class="wy-breadcrumbs-aside"> | ||
{% if pagename != "search" %} | ||
{% if display_github %} | ||
<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> | ||
{% elif display_bitbucket %} | ||
<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> | ||
{% elif show_source and source_url_prefix %} | ||
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">View page source</a> | ||
{% elif show_source and has_source and sourcename %} | ||
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a> | ||
{% block breadcrumbs %} | ||
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> »</li> | ||
{% for doc in parents %} | ||
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> | ||
{% endfor %} | ||
<li>{{ title }}</li> | ||
{% endblock %} | ||
{% block breadcrumbs_aside %} | ||
<li class="wy-breadcrumbs-aside"> | ||
{% if hasdoc(pagename) and display_vcs_links %} | ||
{% if display_github %} | ||
{% if check_meta and 'github_url' in meta %} | ||
<!-- User defined GitHub URL --> | ||
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a> | ||
{% else %} | ||
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a> | ||
{% endif %} | ||
{% elif display_bitbucket %} | ||
{% if check_meta and 'bitbucket_url' in meta %} | ||
<!-- User defined Bitbucket URL --> | ||
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a> | ||
{% else %} | ||
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a> | ||
{% endif %} | ||
{% elif display_gitlab %} | ||
{% if check_meta and 'gitlab_url' in meta %} | ||
<!-- User defined GitLab URL --> | ||
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a> | ||
{% else %} | ||
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a> | ||
{% endif %} | ||
{% elif show_source and source_url_prefix %} | ||
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a> | ||
{% elif show_source and has_source and sourcename %} | ||
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a> | ||
{% endif %} | ||
{% endif %} | ||
{% endif %} | ||
</li> | ||
</li> | ||
{% endblock %} | ||
</ul> | ||
|
||
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %} | ||
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation"> | ||
{% if next %} | ||
<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> | ||
{% endif %} | ||
{% if prev %} | ||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a> | ||
{% endif %} | ||
</div> | ||
{% endif %} | ||
<hr/> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.