sphinx-contrib / googlemaps /

Filename Size Date modified Message
..
sphinxcontrib
49 B
1.5 KB
83 B
1.2 KB
868 B
googlemaps extension README
============================

This is a sphinx extension for embedding maps.

This extension enable you to embed maps using `Google Maps`_ .
Following code is sample::

   .. googlemaps:: Shibuya Station


.. _Google Maps: http://maps.google.com/


Setting
=======

.. You can see available package at `PyPI <http://pypi.python.org/pypi/sphinxcontrib-googlemaps>`_.

You can get archive file at http://bitbucket.org/birkenfeld/sphinx-contrib/

Install
-------

.. code-block:: bash

   > easy_install sphinxcontrib-googlemaps


Configure Sphinx
----------------

To enable this extension, add ``sphinxcontrib.googlemaps`` module to extensions 
option at :file:`conf.py`. 

.. code-block:: python

   import os, sys

   # Path to the folder where sphinxcontrib/googlemaps.py is
   # NOTE: not needed if the package is installed in traditional way
   # using setup.py or easy_install
   sys.path.append(os.path.abspath('/path/to/sphinxcontrib.googlemaps'))

   # Enabled extensions
   extensions = ['sphinxcontrib.googlemaps']


Directive
=========

.. describe:: .. googlemaps:: [location string]

   This directive insert maps into the generated document.

   Examples::

      .. googlemaps:: Shibuya


   You can specify target point by latitude and longitue.

   Example::

      .. googlemaps::
         :latitude: 35.663991
         :longtitude: 139.730988

   googlemaps directive supports these options:

   :balloon: Show ballon to marker
   :zoom: Zoom in/out maps (default value is 15)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.