-
Notifications
You must be signed in to change notification settings - Fork 11
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
Showing
51 changed files
with
3,032 additions
and
232 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
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,20 +1,61 @@ | ||
| """Sphinx ReadTheDocs theme. | ||
| """ | ||
| Sphinx Read the Docs theme. | ||
| From https://github.com/ryan-roemer/sphinx-bootstrap-theme. | ||
| """ | ||
|
|
||
| from os import path | ||
| from sys import version_info as python_version | ||
|
|
||
| __version__ = "0.4.1" | ||
| from sphinx import version_info as sphinx_version | ||
| from sphinx.locale import _ | ||
| from sphinx.util.logging import getLogger | ||
|
|
||
| __version__ = "1.0.0" | ||
| __version_full__ = __version__ | ||
|
|
||
| logger = getLogger(__name__) | ||
|
|
||
|
|
||
| def get_html_theme_path(): | ||
| """Return list of HTML theme paths.""" | ||
| cur_dir = path.abspath(path.dirname(path.dirname(__file__))) | ||
| return cur_dir | ||
|
|
||
|
|
||
| def config_initiated(app, config): | ||
| theme_options = config.html_theme_options or {} | ||
| if theme_options.get("canonical_url"): | ||
| logger.warning(_("The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.")) | ||
|
|
||
|
|
||
| # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package | ||
| def setup(app): | ||
| if python_version[0] < 3: | ||
| logger.warning("Python 2 is deprecated with sphinx_rtd_theme, update to Python 3") | ||
| app.require_sphinx("1.6") | ||
| if sphinx_version <= (2, 0, 0): | ||
| logger.warning("Sphinx 1.x is deprecated with sphinx_rtd_theme, update to Sphinx 2.x or greater") | ||
| if not app.config.html_experimental_html5_writer: | ||
| logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") | ||
| else: | ||
| if app.config.html4_writer: | ||
| logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") | ||
|
|
||
| # 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 >= (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) | ||
| app.connect("config-inited", config_initiated) | ||
|
|
||
| # sphinx emits the permalink icon for headers, so choose one more in keeping with our theme | ||
| if sphinx_version >= (3, 5, 0): | ||
| app.config.html_permalinks_icon = "\uf0c1" | ||
| else: | ||
| app.config.html_add_permalinks = "\uf0c1" | ||
|
|
||
| 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,82 +1,77 @@ | ||
| {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} | ||
| {%- if meta is defined and meta is not none %} | ||
| {%- set check_meta = True %} | ||
| {%- else %} | ||
| {%- set check_meta = False %} | ||
| {%- endif %} | ||
|
|
||
| {% if page_source_suffix %} | ||
| {% set suffix = page_source_suffix %} | ||
| {% else %} | ||
| {% set suffix = source_suffix %} | ||
| {% endif %} | ||
| {%- if check_meta and 'github_url' in meta %} | ||
| {%- set display_github = True %} | ||
| {%- endif %} | ||
|
|
||
| {% if meta is defined and meta is not none %} | ||
| {% set check_meta = True %} | ||
| {% else %} | ||
| {% set check_meta = False %} | ||
| {% endif %} | ||
| {%- if check_meta and 'bitbucket_url' in meta %} | ||
| {%- set display_bitbucket = True %} | ||
| {%- endif %} | ||
|
|
||
| {% if check_meta and 'github_url' in meta %} | ||
| {% set display_github = True %} | ||
| {% endif %} | ||
| {%- if check_meta and 'gitlab_url' in meta %} | ||
| {%- set display_gitlab = 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 %} | ||
|
|
||
| <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| {%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %} | ||
|
|
||
| {#- Translators: This is an ARIA section label for page links, including previous/next page link and links to GitHub/GitLab/etc. -#} | ||
| <div role="navigation" aria-label="{{ _('Page navigation') }}"> | ||
| <ul class="wy-breadcrumbs"> | ||
| {% block breadcrumbs %} | ||
| <li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> »</li> | ||
| {% for doc in parents %} | ||
| {%- 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 %} | ||
| {%- endfor %} | ||
| <li>{{ title }}</li> | ||
| {% endblock %} | ||
| {% block breadcrumbs_aside %} | ||
| {%- endblock %} | ||
| {%- block breadcrumbs_aside %} | ||
| <li class="wy-breadcrumbs-aside"> | ||
| {% if hasdoc(pagename) %} | ||
| {% if display_github %} | ||
| {% if check_meta and 'github_url' in meta %} | ||
| {%- 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 %} | ||
| {%- else %} | ||
| <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_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 %} | ||
| {%- else %} | ||
| <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?mode={{ theme_vcs_pageview_mode or "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 %} | ||
| {%- else %} | ||
| <a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a> | ||
| {%- endif %} | ||
| {%- elif show_source and source_url_prefix %} | ||
| <a href="{{ source_url_prefix }}{{ pagename }}{{ page_source_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 %} | ||
| {%- endif %} | ||
| </li> | ||
| {% endblock %} | ||
| {%- 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" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> | ||
| {% endif %} | ||
| {%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %} | ||
| {#- Translators: This is an ARIA section label for sequential page links, such as previous and next page links. -#} | ||
| <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Sequential page navigation') }}"> | ||
| {%- 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" aria-hidden="true"></span> {{ _('Previous') }}</a> | ||
| {%- endif %} | ||
| {%- 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" aria-hidden="true"></span></a> | ||
| {%- endif %} | ||
| </div> | ||
| {% endif %} | ||
| {%- 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.