mirror of
https://github.com/marceloprates/prettymaps.git
synced 2025-08-29 09:10:26 +02:00
deploy: d2bbf1083a
This commit is contained in:
marceloprates
5800
api/index.html
5800
api/index.html
File diff suppressed because it is too large
Load Diff
120
index.html
120
index.html
@@ -72,7 +72,7 @@
|
||||
<div data-md-component="skip">
|
||||
|
||||
|
||||
<a href="#prettymaps" class="md-skip">
|
||||
<a href="#prettymaps-documentation" class="md-skip">
|
||||
Skip to content
|
||||
</a>
|
||||
|
||||
@@ -213,19 +213,6 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Home
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<a href="." class="md-nav__link md-nav__link--active">
|
||||
|
||||
|
||||
@@ -238,52 +225,6 @@
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#quick-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Quick Example
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@@ -352,41 +293,6 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#quick-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Quick Example
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
@@ -401,28 +307,8 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="prettymaps">prettymaps</h1>
|
||||
<p>A minimal Python library to draw pretty maps from OpenStreetMap data.</p>
|
||||
<ul>
|
||||
<li><a href="usage/">Usage</a></li>
|
||||
<li><a href="api/">API Reference</a></li>
|
||||
</ul>
|
||||
<h2 id="features">Features</h2>
|
||||
<ul>
|
||||
<li>Draw beautiful maps from OSM data</li>
|
||||
<li>Highly customizable layers and styles</li>
|
||||
<li>Preset management</li>
|
||||
<li>Keypoint highlighting</li>
|
||||
</ul>
|
||||
<h2 id="installation">Installation</h2>
|
||||
<pre><code class="language-bash">pip install prettymaps
|
||||
</code></pre>
|
||||
<h2 id="quick-example">Quick Example</h2>
|
||||
<pre><code class="language-python">import prettymaps
|
||||
prettymaps.plot("Porto Alegre")
|
||||
</code></pre>
|
||||
<hr />
|
||||
<p>Data © OpenStreetMap contributors </p>
|
||||
<h1 id="prettymaps-documentation">Prettymaps Documentation</h1>
|
||||
<p>Welcome to the Prettymaps documentation site. </p>
|
||||
|
||||
|
||||
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
171
usage/index.html
171
usage/index.html
@@ -237,19 +237,6 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Usage
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<a href="./" class="md-nav__link md-nav__link--active">
|
||||
|
||||
|
||||
@@ -262,70 +249,6 @@
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#basic-usage" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Basic Usage
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#customizing-layers-and-styles" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Customizing Layers and Styles
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#using-presets" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Using Presets
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#highlighting-keypoints" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Highlighting Keypoints
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#saving-maps" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Saving Maps
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@@ -372,59 +295,6 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#basic-usage" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Basic Usage
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#customizing-layers-and-styles" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Customizing Layers and Styles
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#using-presets" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Using Presets
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#highlighting-keypoints" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Highlighting Keypoints
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#saving-maps" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Saving Maps
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
@@ -440,45 +310,8 @@
|
||||
|
||||
|
||||
<h1 id="usage">Usage</h1>
|
||||
<h2 id="basic-usage">Basic Usage</h2>
|
||||
<p>The main entry point is the <code>plot()</code> function:</p>
|
||||
<pre><code class="language-python">import prettymaps
|
||||
prettymaps.plot("Porto Alegre")
|
||||
</code></pre>
|
||||
<p>This will generate a map for the given location using default layers and styles.</p>
|
||||
<h2 id="customizing-layers-and-styles">Customizing Layers and Styles</h2>
|
||||
<p>You can customize which OpenStreetMap layers are shown and how they are styled:</p>
|
||||
<pre><code class="language-python">layers = {
|
||||
"perimeter": {},
|
||||
"streets": {"width": 8},
|
||||
"buildings": {},
|
||||
}
|
||||
style = {
|
||||
"perimeter": {"fc": "#f2efe9"},
|
||||
"streets": {"fc": "#cccccc", "ec": "#333333"},
|
||||
"buildings": {"fc": "#bdbdbd"},
|
||||
}
|
||||
prettymaps.plot("Porto Alegre", layers=layers, style=style)
|
||||
</code></pre>
|
||||
<h2 id="using-presets">Using Presets</h2>
|
||||
<p>Presets are reusable configurations for layers and styles. You can load, save, or update presets:</p>
|
||||
<pre><code class="language-python">prettymaps.plot("Porto Alegre", preset="default")
|
||||
</code></pre>
|
||||
<p>You can also create your own presets and save them for later use.</p>
|
||||
<h2 id="highlighting-keypoints">Highlighting Keypoints</h2>
|
||||
<p>You can highlight specific keypoints (e.g., landmarks) on the map:</p>
|
||||
<pre><code class="language-python">keypoints = {
|
||||
"tags": {"tourism": "attraction"},
|
||||
"kwargs": {"bbox": {"fc": "yellow"}},
|
||||
}
|
||||
prettymaps.plot("Porto Alegre", keypoints=keypoints)
|
||||
</code></pre>
|
||||
<h2 id="saving-maps">Saving Maps</h2>
|
||||
<p>You can save the generated map to a file:</p>
|
||||
<pre><code class="language-python">prettymaps.plot("Porto Alegre", save_as="map.png")
|
||||
</code></pre>
|
||||
<hr />
|
||||
<p>See the <a href="../api/">API Reference</a> for details on all functions and parameters. </p>
|
||||
<p>This page will describe how to use Prettymaps.</p>
|
||||
<p><em>More details coming soon!</em> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user