Skip to content

Commit

Permalink
Merge pull request #141 from martinRenou/add_related_projects_doc
Browse files Browse the repository at this point in the history 
Add "related projects" section in documentation
  • Loading branch information
@SylvainCorlay
SylvainCorlay committed Apr 23, 2018
2 parents 72c761a + 5322c99 commit 20d5c0f
Show file tree
Hide file tree
Showing 10 changed files with 6,336 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/source/_static/main_stylesheet.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content{
max-width: 100%;
}
9 changes: 8 additions & 1 deletion docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,21 @@

import sphinx_rtd_theme


def setup(app):
app.add_javascript("https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js")
app.add_javascript("https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js")

app.add_stylesheet("main_stylesheet.css")

html_theme = "sphinx_rtd_theme"

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

extensions = ['breathe']
breathe_projects = { 'xwidgets': '../xml' }
templates_path = ['_templates']
html_static_path = ['_static']
source_suffix = '.rst'
master_doc = 'index'
project = 'xwidgets'
Expand All @@ -31,4 +39,3 @@
pygments_style = 'sphinx'
todo_include_todos = False
htmlhelp_basename = 'xwidgetsdoc'

336 changes: 336 additions & 0 deletions docs/source/embed_widgets/xleaflet_example.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,336 @@
<script type="application/vnd.jupyter.widget-state+json">
{
"version_major": 2,
"version_minor": 0,
"state": {
"48c671fb9cdc4c918627b5cfab19e766": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"5ba1d550414d4950a6be3808a3144b6e": {
"model_name": "HTMLModel",
"model_module": "@jupyter-widgets/controls",
"model_module_version": "1.1.0",
"state": {
"_model_module_version": "1.1.0",
"_view_module_version": "1.1.0",
"layout": "IPY_MODEL_48c671fb9cdc4c918627b5cfab19e766",
"placeholder": " ",
"value": "Hello from an xwidget in an xmarker!"
}
},
"44527437676b4d59bc13eacb39a6e366": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"1cca0dbcc5934fc2aa933644c77354f1": {
"model_name": "LeafletMapModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"bounds": [
[
0,
0
],
[
0,
0
]
],
"bounds_polygon": [
[
0,
0
],
[
0,
0
],
[
0,
0
],
[
0,
0
]
],
"center": [
52.204793,
360.121558
],
"layers": [
"IPY_MODEL_59b84b87c0404f83b7881261dad9e4d8",
"IPY_MODEL_c229e1d5fedf41cea687de4cf01407a6"
],
"layout": "IPY_MODEL_44527437676b4d59bc13eacb39a6e366",
"options": [
"center",
"zoom_start",
"zoom",
"max_zoom",
"min_zoom",
"dragging",
"touch_zoom",
"scroll_wheel_zoom",
"double_click_zoom",
"box_zoom",
"tap",
"tap_tolerance",
"world_copy_jump",
"close_popup_on_click",
"bounce_at_zoom_limits",
"keyboard",
"keyboard_pan_offset",
"keyboard_zoom_offset",
"inertia",
"inertia_deceleration",
"inertia_max_speed",
"zoom_control",
"attribution_control",
"zoom_animation_threshold"
],
"zoom": 15,
"south": 52.1995322644825,
"north": 52.21005237674974,
"east": 360.1423931121826,
"west": 180
}
},
"f5bc4e1318bf42f3929145a7fcc0b1b6": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"c229e1d5fedf41cea687de4cf01407a6": {
"model_name": "LeafletMarkerModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"base": true,
"bottom": true,
"draggable": false,
"layout": "IPY_MODEL_f5bc4e1318bf42f3929145a7fcc0b1b6",
"location": [
52.204793,
360.121558
],
"options": [
"z_index_offset",
"draggable",
"keyboard",
"title",
"alt",
"rise_on_hover",
"rise_offset"
],
"popup": "IPY_MODEL_5ba1d550414d4950a6be3808a3144b6e"
}
},
"90c69dc47b1e4f449b3b8a11e98c13c1": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"59b84b87c0404f83b7881261dad9e4d8": {
"model_name": "LeafletTileLayerModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"base": true,
"layout": "IPY_MODEL_90c69dc47b1e4f449b3b8a11e98c13c1",
"max_zoom": 19,
"min_zoom": 1,
"name": "OpenStreetMap.Mapnik",
"options": [
"min_zoom",
"max_zoom",
"tile_size",
"attribution",
"detect_retina"
]
}
},
"3e778425e9a940f8abee06ad3b96b8ea": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"e55b517d2c944cd095e91b130bef34f1": {
"model_name": "HTMLModel",
"model_module": "@jupyter-widgets/controls",
"model_module_version": "1.1.0",
"state": {
"_model_module_version": "1.1.0",
"_view_module_version": "1.1.0",
"layout": "IPY_MODEL_3e778425e9a940f8abee06ad3b96b8ea",
"placeholder": " ",
"value": "Hello from an <b>xwidget</b> in an <b>xmarker</b>!"
}
},
"3d39abdc08374564a82fdac24efbf9b3": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"a3a20d7b461a4a2db1cd94f1b8f70c47": {
"model_name": "LeafletMapModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"bounds": [
[
0,
0
],
[
0,
0
]
],
"bounds_polygon": [
[
0,
0
],
[
0,
0
],
[
0,
0
],
[
0,
0
]
],
"center": [
52.204793,
360.121558
],
"layers": [
"IPY_MODEL_30f545d92fd64ee282f7ddeafd47fa78",
"IPY_MODEL_3bac050035e64fa7bef40420b64b7098"
],
"layout": "IPY_MODEL_3d39abdc08374564a82fdac24efbf9b3",
"options": [
"center",
"zoom_start",
"zoom",
"max_zoom",
"min_zoom",
"dragging",
"touch_zoom",
"scroll_wheel_zoom",
"double_click_zoom",
"box_zoom",
"tap",
"tap_tolerance",
"world_copy_jump",
"close_popup_on_click",
"bounce_at_zoom_limits",
"keyboard",
"keyboard_pan_offset",
"keyboard_zoom_offset",
"inertia",
"inertia_deceleration",
"inertia_max_speed",
"zoom_control",
"attribution_control",
"zoom_animation_threshold"
],
"zoom": 15,
"south": 52.1995322644825,
"north": 52.21005237674974,
"east": 360.1423931121826,
"west": 180
}
},
"6bb97d6380484ee183e56ad42d1667b1": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"3bac050035e64fa7bef40420b64b7098": {
"model_name": "LeafletMarkerModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"base": true,
"bottom": true,
"draggable": false,
"layout": "IPY_MODEL_6bb97d6380484ee183e56ad42d1667b1",
"location": [
52.204793,
360.121558
],
"options": [
"z_index_offset",
"draggable",
"keyboard",
"title",
"alt",
"rise_on_hover",
"rise_offset"
],
"popup": "IPY_MODEL_e55b517d2c944cd095e91b130bef34f1"
}
},
"d2be5cff474549e18fe6533584ba82f6": {
"model_name": "LayoutModel",
"model_module": "@jupyter-widgets/base",
"model_module_version": "1.0.0",
"state": {}
},
"30f545d92fd64ee282f7ddeafd47fa78": {
"model_name": "LeafletTileLayerModel",
"model_module": "jupyter-leaflet",
"model_module_version": "0.8.1",
"state": {
"_dom_classes": [],
"_model_module_version": "0.8.1",
"_view_module_version": "0.8.1",
"base": true,
"layout": "IPY_MODEL_d2be5cff474549e18fe6533584ba82f6",
"max_zoom": 19,
"min_zoom": 1,
"name": "OpenStreetMap.Mapnik",
"options": [
"min_zoom",
"max_zoom",
"tile_size",
"attribution",
"detect_retina"
]
}
}
}
}
</script>

0 comments on commit 20d5c0f

Please sign in to comment.