Skip to content

Commit 337b2ff

Browse files
author
Martin Journois
committed
Doc structure
1 parent bd70fbd commit 337b2ff

10 files changed

Lines changed: 299 additions & 322 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ ENV
4747

4848
# Tests products
4949
.cache
50+
data.png
51+
map.html
5052

5153
# documentation builds
5254
docs/_build

docs/_themes/f6/layout.html

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
{% extends "basic/layout.html" %}
2-
3-
{%- block doctype -%}
4-
<!DOCTYPE html>
5-
{%- endblock -%}
6-
7-
{%- block extrahead -%}
8-
<link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,300italic,400italic,600italic|Source+Code+Pro' rel='stylesheet' type='text/css'>
9-
{%- endblock -%}
10-
11-
{# put the sidebar before the body #}
12-
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
13-
{% block sidebar2 %}{% endblock %}
14-
15-
{%- block footer %}
16-
<div class="footer">
17-
{%- if show_copyright %}
18-
{%- if hasdoc('copyright') %}
19-
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
20-
{%- else %}
21-
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
22-
{%- endif %}
23-
{%- endif %}
24-
{%- if last_updated %}
25-
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
26-
{%- endif %}
27-
{%- if show_sphinx %}
28-
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.Theme by <a href="http://github.com/vkvn">vkvn</a>{% endtrans %}
29-
{%- endif %}
30-
</div>
31-
{%- endblock %}
1+
{% extends "basic/layout.html" %}
2+
3+
{%- block doctype -%}
4+
<!DOCTYPE html>
5+
{%- endblock -%}
6+
7+
{%- block extrahead -%}
8+
{%- endblock -%}
9+
10+
{# put the sidebar before the body #}
11+
{% block sidebar1 %}{{ sidebar() }}{% endblock %}
12+
{% block sidebar2 %}{% endblock %}
13+
14+
{%- block footer %}
15+
<div class="footer">
16+
{%- if show_copyright %}
17+
{%- if hasdoc('copyright') %}
18+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
19+
{%- else %}
20+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
21+
{%- endif %}
22+
{%- endif %}
23+
{%- if last_updated %}
24+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
25+
{%- endif %}
26+
{%- if show_sphinx %}
27+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.Theme by <a href="http://github.com/vkvn">vkvn</a>{% endtrans %}
28+
{%- endif %}
29+
</div>
30+
{%- endblock %}

docs/contributing.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Choose the sandbox folder of your choice (`~/sandbox` for example)
2+
::
3+
4+
$ cd ~/sandbox
5+
6+
Clone `folium` from github:
7+
::
8+
9+
$ git clone https://github.com/python-visualization/folium
10+
11+
Push code to your fors, and write a pull request.
12+
13+
TODO: end up this section.

0 commit comments

Comments
 (0)