Skip to content

Commit 500f490

Browse files
sdispatersdispater
committed
Fixes a link in documentation
1 parent 5dda5de commit 500f490

File tree

9 files changed

+214
-1
lines changed

9 files changed

+214
-1
lines changed

‎docs/_theme/__init__.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""Sphinx ReadTheDocs theme.
2+
3+
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
4+
5+
"""
6+
import os
7+
8+
VERSION = (0, 1, 8)
9+
10+
__version__ = ".".join(str(v) for v in VERSION)
11+
__version_full__ = __version__
12+
13+
14+
def get_html_theme_path():
15+
"""Return list of HTML theme paths."""
16+
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
17+
return cur_dir

‎docs/_theme/breadcrumbs.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<div role="navigation" aria-label="breadcrumbs navigation">
2+
<ul class="wy-breadcrumbs">
3+
<li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
4+
{% for doc in parents %}
5+
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
6+
{% endfor %}
7+
<li>{{ title }}</li>
8+
<li class="wy-breadcrumbs-aside">
9+
{% if pagename != "search" %}
10+
{% if display_github %}
11+
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-github"> Edit on GitHub</a>
12+
{% elif display_bitbucket %}
13+
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
14+
{% elif show_source and source_url_prefix %}
15+
<a href="{{ source_url_prefix }}{{ pagename }}{{ source_suffix }}">View page source</a>
16+
{% elif show_source and has_source and sourcename %}
17+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
18+
{% endif %}
19+
{% endif %}
20+
</li>
21+
</ul>
22+
<hr/>
23+
</div>

‎docs/_theme/footer.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<footer>
2+
{% if next or prev %}
3+
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
4+
{% if next %}
5+
<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>
6+
{% endif %}
7+
{% if prev %}
8+
<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>
9+
{% endif %}
10+
</div>
11+
{% endif %}
12+
13+
</footer>
14+

‎docs/_theme/layout.html‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
layout: documentation
3+
title: {{ title|striptags|e }}
4+
---
5+
6+
{# TEMPLATE VAR SETTINGS #}
7+
{%- set url_root = pathto('', 1) %}
8+
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
9+
{%- if not embedded and docstitle %}
10+
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
11+
{%- else %}
12+
{%- set titlesuffix = "" %}
13+
{%- endif %}
14+
15+
<!-- START CONTENT SECTION -->
16+
<section class="sm-p-b-30 p-b-70 p-t-100">
17+
<div class="container">
18+
<div class="row">
19+
<div class="col-sm-6 col-sm-offset-3 text-center p-t-100">
20+
<h1 class="m-t-5">Documentation</h1>
21+
</div>
22+
</div>
23+
</div>
24+
</section>
25+
<!-- END CONTENT SECTION -->
26+
27+
<section class="p-b-50 p-t-50 documentation-content">
28+
<div class="container">
29+
<div class="panel panel-transparent">
30+
<div class="bg-white row p-l-20 p-r-20 p-b-20 p-t-5 xs-no-padding">
31+
<div class="row">
32+
<div class="col-md-4">
33+
<nav data-toggle="wy-nav-shift" class="wy-nav-side p-t-40">
34+
<div class="documentation-menu" role="navigation" aria-label="main navigation">
35+
{% block menu %}
36+
{% set toctree = toctree(maxdepth=3, collapse=True, includehidden=True) %}
37+
{% if toctree %}
38+
{{ toctree }}
39+
{% else %}
40+
<!-- Local TOC -->
41+
<div class="local-toc">{{ toc }}</div>
42+
{% endif %}
43+
{% endblock %}
44+
</div>
45+
&nbsp;
46+
</nav>
47+
</div>
48+
<div class="col-md-8 documentation-body">
49+
{% block body %}{% endblock %}
50+
</div>
51+
</div>
52+
</div>
53+
</div>
54+
</div>
55+
</section>

‎docs/_theme/search.html‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{#
2+
basic/search.html
3+
~~~~~~~~~~~~~~~~~
4+
5+
Template for the search page.
6+
7+
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
8+
:license: BSD, see LICENSE for details.
9+
#}
10+
{%- extends "layout.html" %}
11+
{% set title = _('Search') %}
12+
{% set script_files = script_files + ['_static/searchtools.js'] %}
13+
{% block footer %}
14+
<script type="text/javascript">
15+
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
16+
</script>
17+
{# this is used when loading the search index using $.ajax fails,
18+
such as on Chrome for documents on localhost #}
19+
<script type="text/javascript" id="searchindexloader"></script>
20+
{{ super() }}
21+
{% endblock %}
22+
{% block body %}
23+
<noscript>
24+
<div id="fallback" class="admonition warning">
25+
<p class="last">
26+
{% trans %}Please activate JavaScript to enable the search
27+
functionality.{% endtrans %}
28+
</p>
29+
</div>
30+
</noscript>
31+
32+
{% if search_performed %}
33+
<h2>{{ _('Search Results') }}</h2>
34+
{% if not search_results %}
35+
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
36+
{% endif %}
37+
{% endif %}
38+
<div id="search-results">
39+
{% if search_results %}
40+
<ul>
41+
{% for href, caption, context in search_results %}
42+
<li>
43+
<a href="{{ pathto(item.href) }}">{{ caption }}</a>
44+
<p class="context">{{ context|e }}</p>
45+
</li>
46+
{% endfor %}
47+
</ul>
48+
{% endif %}
49+
</div>
50+
{% endblock %}

‎docs/_theme/searchbox.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{%- if builder != 'singlehtml' %}
2+
<div role="search">
3+
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
4+
<input type="text" name="q" placeholder="Search docs" />
5+
<input type="hidden" name="check_keywords" value="yes" />
6+
<input type="hidden" name="area" value="default" />
7+
</form>
8+
</div>
9+
{%- endif %}

‎docs/_theme/theme.conf‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[theme]
2+
inherit = basic
3+
4+
[options]
5+
typekit_id = hiw1hhg
6+
analytics_id =
7+
sticky_navigation = False
8+
logo_only =

‎docs/_theme/versions.html‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{% if READTHEDOCS %}
2+
{# Add rst-badge after rst-versions for small badge style. #}
3+
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
4+
<span class="rst-current-version" data-toggle="rst-current-version">
5+
<span class="fa fa-book"> Read the Docs</span>
6+
v: {{ current_version }}
7+
<span class="fa fa-caret-down"></span>
8+
</span>
9+
<div class="rst-other-versions">
10+
<dl>
11+
<dt>Versions</dt>
12+
{% for slug, url in versions %}
13+
<dd><a href="{{ url }}">{{ slug }}</a></dd>
14+
{% endfor %}
15+
</dl>
16+
<dl>
17+
<dt>Downloads</dt>
18+
{% for type, url in downloads %}
19+
<dd><a href="{{ url }}">{{ type }}</a></dd>
20+
{% endfor %}
21+
</dl>
22+
<dl>
23+
<dt>On Read the Docs</dt>
24+
<dd>
25+
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a>
26+
</dd>
27+
<dd>
28+
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a>
29+
</dd>
30+
</dl>
31+
<hr/>
32+
Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
33+
34+
</div>
35+
</div>
36+
{% endif %}
37+

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ You can also set the default ``__str__`` format.
462462
Custom Directives
463463
-----------------
464464

465-
Apart from the `default directives <For localization support see the Localization section.>`_,
465+
Apart from the `default directives <https://docs.python.org/3.5/library/time.html#time.strftime>`_,
466466
Pendulum comes with its own (each custom directive is in the form ``%_{directive}``):
467467

468468
=========== ======================================================================== =================================

0 commit comments

Comments
 (0)