Skip to main content

Sphinx "externallinks" extension

Project description

This package contains the externallinks Sphinx extension.

.. add description here ..
sphinxcontrib.externallinks
===========================

Roles
-----

This module defines some roles.

`google` It takes a single, requiredargument, keywords for search::

:google:`world heritage sites in japan`

`google-images` It takes a single, requiredargument, keywords for image search::

:google-images:`world heritage sites in japan`

`google-maps-fromto` It takes a single, requiredargument, keywords for maps search::

:google-maps-fromto:`from Mt.Fuji to Hiraizumi` by public transit
:google-maps-fromto:`driving from Mt.Fuji to Hiraizumi` by car
:google-maps-fromto:`walking from Mt.Fuji to Hiraizumi`

:google-maps-fromto:`from Mt.Fuji to Hiraizumi <富士山,平泉町>` by public transit
:google-maps-fromto:`driving from Mt.Fuji to Hiraizumi <富士山,平泉町,d>` by car
:google-maps-fromto:`walking from Mt.Fuji to Hiraizumi <富士山,平泉町,w>`

`img-altfix` It takes a single, requiredargument, image url.
This example, `http://example.com/alt.png` is not none, so fail over `src` attribute to local file of `img` as example.com::

:img-altfix:`http://example.com/alt.png`

`tenkipast` It takes a single, requiredargument, prefecture and date for the weather of the past in Japan(tenki.jp)::

:tenkipast:`東京,2013/07/16`

`wikipedia` It takes a single, requiredargument, langage and keywords for wikipedia's url::

:wikipedia:`ja,フィリピンのバロック様式教会群`

`whc` , `whct` and `whcl` It takes a single, requiredargument, number of UNESCO's World Heritage sites list or tentative list::

:whc:`0662` Yakushima (list of World Heritage sites)
:whct:`0370` Temples, Shrines and other structures of Ancient Kamakura (tentative list of World Heritage)
:whcl:`ph` Philippines: Properties inscribed on the World Heritage List

Directives
----------

This module defines some directives.

Google Maps
^^^^^^^^^^^

`google-maps` It takes a single, requiredargument, keywords for maps search.

Default using Static Maps API::

.. google-maps::
:center: Berkeley,CA
:zoom: 14
:width: 400
:height: 400

Embed API modes as below::

.. google-maps:: Fisht Olympic Stadium, Sochi Russia
:mode: place

.. google-maps::
:mode: directions
:origin: Oslo Norway
:destination: Telemark Norway
:avoid: tolls|highways

.. google-maps:: record stores in Seattle
:mode: search

.. google-maps::
:mode: view
:center: 37.4218,-122.0840
:zoom: 18
:maptype: satellite

Optional parameters of Static API:

:key: Google API key.
default using `google_api_key` in conf.py.
will generate url without `key` parameter if empty
:width: default 600, used for size
:height: default 450, used for size
:scale:
:format:
:maptype:
:language:
:region:
:markers:
:path:
:visible:
:style:
:sensor: always set to false

see the Google Maps Static API: https://developers.google.com/maps/documentation/staticmaps/


Optional parameters of Embed API:

:key: Google API key, required for Embed API.
default using `google_api_key` in conf.py
:width: default 600
:height: default 450
:q:
:mode: place, directions, search or view
:origin:
:destination:
:avoid:
:center:
:zoom:
:maptype:
:language:
:region:

see the Google Maps Embed API: https://developers.google.com/maps/documentation/embed/guide


`google-maps-legacy` It takes a single, requiredargument, keywords for maps search::

.. google-maps-legacy:: Yakushima
:zoom: 10

.. google-maps-legacy:: Philippines
:latitude: 12.3
:longtitude: 123.4
:zoom: 5

.. google-maps-legacy:: driving from Mt.Fuji to Hiraizumi
:saddr: 富士山
:daddr: 平泉町
:dirflg: d

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib-externallinks-0.1dev-20140407.tar.gz (7.4 kB) Copy SHA256 hash SHA256 Source None Apr 6, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page