Skip to content

Documentation project #1700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 42 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
66bf21c
Remove unnecessary heading
Conengmo Jan 8, 2023
b6e361b
Mark private classes
Conengmo Jan 8, 2023
afc3bca
New Sphinx theme
Conengmo Jan 8, 2023
f5aff8a
autodoc default options
Conengmo Jan 8, 2023
e3cb2d3
Include links to branca
Conengmo Jan 8, 2023
da0fe35
sphinx theme requirement
Conengmo Jan 8, 2023
55cb2e0
Include indices and tables
Conengmo Jan 8, 2023
e602955
add support for testing .md notebooks
Conengmo Jan 11, 2023
4d8c774
Use Myst Markdown in Sphinx docs
Conengmo Jan 11, 2023
da484fa
Update .gitignore
Conengmo Jan 11, 2023
0483d26
Getting Started
Conengmo Jan 11, 2023
c4d5649
work on quickstart
Conengmo Jan 21, 2023
0154575
remove trailing white space
Conengmo Jan 21, 2023
1f51ad8
typo, remove 3rd marker
Conengmo Apr 6, 2023
d4775c6
Use Pydata sphinx theme
Conengmo Apr 6, 2023
e0a7061
better organization
Conengmo May 18, 2023
c61d420
user guide and advanced guide scaffolding
Conengmo May 18, 2023
fb78f3e
more width
Conengmo May 18, 2023
81a6f65
copying over example notebooks part 1
Conengmo May 18, 2023
8cf9690
move over all example notebooks
Conengmo May 19, 2023
4db3249
make data examples available in folium
Conengmo May 19, 2023
b50d1b7
use new example data functions in docs
Conengmo May 19, 2023
4f65e19
no longer copy quickstart
Conengmo May 19, 2023
b8c0e1b
fix/remove broken links
Conengmo May 19, 2023
6864139
Revert "fix/remove broken links"
Conengmo May 24, 2023
cd532a2
fix broken links, use https
Conengmo May 24, 2023
36a3687
Merge remote-tracking branch 'upstream/main' into documentation-project
Conengmo May 24, 2023
1f580bc
Merge remote-tracking branch 'upstream/main' into documentation-project
Conengmo May 24, 2023
d4334e0
deploy to gh-pages/dev
Conengmo May 24, 2023
6558f25
Update deploy-docs.yml
Conengmo May 28, 2023
c2b2555
fix pre-commit
Conengmo May 28, 2023
5b0bfec
switcher config
Conengmo May 28, 2023
08cb84b
Update deploy-docs.yml
Conengmo May 28, 2023
cd8644c
use folium-example-data repo
Conengmo Sep 5, 2023
36c8b46
don't render WmsTimeDimension example
Conengmo Sep 5, 2023
93651f5
use correct raw github urls (and other fixes)
Conengmo Sep 5, 2023
2c1af85
deprecated footer_items -> footer_start
Conengmo Sep 5, 2023
51ddde9
precommit
Conengmo Sep 5, 2023
0d34f14
selenium tests: only docs, not old notebooks
Conengmo Sep 5, 2023
bcb59fe
fix selenium test path
Conengmo Sep 5, 2023
39f5bec
fix selenium test path (again)
Conengmo Sep 5, 2023
15b6a0a
Update timeslider_choropleth.md
Conengmo Sep 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,23 @@ jobs:
shell: bash -l {0}
run: |
set -e
cp examples/Quickstart.ipynb docs/quickstart.ipynb
pushd docs
make clean html linkcheck
popd

- name: GitHub Pages action
- name: Publish to Github Pages on main
if: ${{ github.ref == 'refs/heads/main' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html/
destination_dir: latest
keep_files: false

- name: Publish to Github Pages on release
if: ${{ github.event_name == 'release' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html/
destination_dir: ${{ github.ref_name }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.pytest_cache
build/
dist/
docs/index.html
docs/_build/
docs/quickstart.ipynb
examples/results/*
Expand Down
4 changes: 4 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.bd-content {
flex-grow: 1;
max-width: 100%;
}
92 changes: 92 additions & 0 deletions docs/_static/flask_example.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
""" flask_example.py

Required packages:
- flask
- folium

Usage:

Start the flask server by running:

$ python flask_example.py

And then head to http://127.0.0.1:5000/ in your browser to see the map displayed

"""

from flask import Flask, render_template_string

import folium

app = Flask(__name__)


@app.route("/")
def fullscreen():
"""Simple example of a fullscreen map."""
m = folium.Map()
return m.get_root().render()


@app.route("/iframe")
def iframe():
"""Embed a map as an iframe on a page."""
m = folium.Map()

# set the iframe width and height
m.get_root().width = "800px"
m.get_root().height = "600px"
iframe = m.get_root()._repr_html_()

return render_template_string(
"""
<!DOCTYPE html>
<html>
<head></head>
<body>
<h1>Using an iframe</h1>
{{ iframe|safe }}
</body>
</html>
""",
iframe=iframe,
)


@app.route("/components")
def components():
"""Extract map components and put those on a page."""
m = folium.Map(
width=800,
height=600,
)

m.get_root().render()
header = m.get_root().header.render()
body_html = m.get_root().html.render()
script = m.get_root().script.render()

return render_template_string(
"""
<!DOCTYPE html>
<html>
<head>
{{ header|safe }}
</head>
<body>
<h1>Using components</h1>
{{ body_html|safe }}
<script>
{{ script|safe }}
</script>
</body>
</html>
""",
header=header,
body_html=body_html,
script=script,
)


if __name__ == "__main__":
app.run(debug=True)
46 changes: 46 additions & 0 deletions docs/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
[
{
"version": "v0.14.0 (stable)",
"url": "https://python-visualization.github.io/folium/version-v0.14.0/"
},
{
"version": "v0.12.1",
"url": "https://python-visualization.github.io/folium/version-v0.12.1/"
},
{
"version": "v0.12.0",
"url": "https://python-visualization.github.io/folium/version-v0.12.0/"
},
{
"version": "v0.11.0",
"url": "https://python-visualization.github.io/folium/version-v0.11.0/"
},
{
"version": "v0.10.1",
"url": "https://python-visualization.github.io/folium/version-v0.10.1/"
},
{
"version": "v0.10.0",
"url": "https://python-visualization.github.io/folium/version-v0.10.0/"
},
{
"version": "v0.9.1",
"url": "https://python-visualization.github.io/folium/version-v0.9.1/"
},
{
"version": "v0.9.0",
"url": "https://python-visualization.github.io/folium/version-v0.9.0/"
},
{
"version": "v0.8.3",
"url": "https://python-visualization.github.io/folium/version-v0.8.3/"
},
{
"version": "v0.8.2",
"url": "https://python-visualization.github.io/folium/version-v0.8.2/"
},
{
"version": "v0.8.1",
"url": "https://python-visualization.github.io/folium/version-v0.8.1/"
}
]
2 changes: 2 additions & 0 deletions docs/_templates/version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- This will display the version of the docs -->
Folium version {{ version }}
7 changes: 0 additions & 7 deletions docs/_themes/f6/NEWS.txt

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_themes/f6/layout.html

This file was deleted.

Binary file removed docs/_themes/f6/static/brillant.png
Binary file not shown.
Loading