-
Notifications
You must be signed in to change notification settings - Fork 432
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master' into issue-2923
- Loading branch information
Showing
84 changed files
with
6,635 additions
and
1,286 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
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 |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Boundless Read the Docs Theme | ||
|
|
||
| Operates as an extension of ``sphinx_rtd_theme`` originated by Boundless | ||
|
|
||
| Reference: | ||
|
|
||
| * https://github.com/rtfd/sphinx_rtd_theme | ||
|
|
||
| ## Configuration | ||
|
|
||
| Configuration options provided by ``boundess_rtd`: | ||
|
|
||
| ``` | ||
| html_theme_options = { | ||
| 'display_connect': False #Ask a Question | ||
| } | ||
| ``` | ||
|
|
||
| Configuration options provided by `sphinx_rtd_theme`: | ||
|
|
||
| ``` | ||
| html_theme_options = { | ||
| 'canonical_url': '', | ||
| 'analytics_id': '', | ||
| 'logo_only': False, | ||
| 'display_version': True, | ||
| 'prev_next_buttons_location': 'both', | ||
| 'style_external_links': True, | ||
| 'vcs_pageview_mode': '', | ||
| # Toc options | ||
| 'collapse_navigation': False, | ||
| 'sticky_navigation': True, | ||
| 'navigation_depth': 3, | ||
| 'includehidden': True, | ||
| 'titles_only': False | ||
| } | ||
| ``` | ||
|
|
||
| For the navigation bar to work correctly be sure to include captions in your `tocreee` definitions. | ||
|
|
||
| ## Implementation | ||
|
|
||
| Care is taken to override the `sphinx_rtd_theme` CSS settings as required, rather than duplicate the files. This approach allows us to update `sphinx_rtd_theme` over time to take advantage features and fixes. | ||
|
|
||
| The following is an outline of `boundless_rtd` contents: | ||
|
|
||
| * static/css/boundless.css - provides font selection and overides branding elements | ||
| * static/fonts/proximanova-* | ||
| * static/fonts/sourcecodepro-* | ||
| * static/img/boundless-logo-32.png | ||
| * static/img/powered-by-boundless*.png | ||
| * static/js/ |
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 |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} | ||
|
|
||
| {% 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 %} | ||
|
|
||
| <div role="navigation" aria-label="breadcrumbs navigation"> | ||
|
|
||
| <ul class="wy-breadcrumbs"> | ||
| {% if title != project %} | ||
| <li><a href="{{ pathto(master_doc) }}"> {{ shorttitle }} </a> »</li> | ||
| {% for doc in parents %} | ||
| <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> | ||
| {% endfor %} | ||
| <li>{{ title }}</li> | ||
| {% else %} | ||
| <li><a href="{{ pathto(master_doc) }}"> {{ shorttitle }} </a></li> | ||
| {% endif %} | ||
|
|
||
| {% block breadcrumbs_aside %} | ||
| <li class="wy-breadcrumbs-aside"> | ||
| {% if hasdoc(pagename) %} | ||
| {% 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 %} | ||
| </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
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.