Sphinx "Google Drive" extension; embed images on Google Drive
Project description
sphinxcontrib-googledrive
=========================
This Sphinx extension allows you to embed images on `Google Drive`_ into your document::
.. image:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
.. _Google Drive: https://www.google.com/drive/
Setting
=======
Install
-------
::
$ pip install sphinxcontrib-googledrive
Prepare your Google Apps
------------------------
This extension expects you to create Google Apps and its Service Account.
Please read the document of `Google Client Libraries: Using OAuth 2.0 for
Server to Server Applications`_ and create your service account. And
please generate a private key for the account.
.. _Google Client Libraries: Using OAuth 2.0 for Server to Server Applications`: https://developers.google.com/api-client-library/python/auth/service-accounts
Configure Sphinx
----------------
Add ``sphinxcontrib.googledrive`` to ``extensions`` at `conf.py`::
extensions += ['sphinxcontrib.googledrive']
And let the private key for your service account to Sphinx through one of
the following methods:
1. Set content of the private key via environment variable
`GOOGLE_DRIVE_SERVICE_ACCOUNT_KEY`::
$ export GOOGLE_DRIVE_SERVICE_ACCOUNT_KEY='{"type": "service_account", ...}'
2. Set a path to the private key file via `googledrive_service_account`
in `conf.py`::
googledrive_service_account = '/path/to/private.key'
Usage
=====
Please give an URL of caoo diagrams to image_ or figure_ directives
as an argument::
.. image:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
.. figure:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
caption of figure
.. _image: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image
.. _figure: http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure
Configuration Options
======================
**googledrive_service_account**
A path to private key for service account.
**googledrive_trim_images**
Trim white space or not (boolean).
Repository
==========
https://github.com/tk0miya/sphinxcontrib-googledrive
=========================
This Sphinx extension allows you to embed images on `Google Drive`_ into your document::
.. image:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
.. _Google Drive: https://www.google.com/drive/
Setting
=======
Install
-------
::
$ pip install sphinxcontrib-googledrive
Prepare your Google Apps
------------------------
This extension expects you to create Google Apps and its Service Account.
Please read the document of `Google Client Libraries: Using OAuth 2.0 for
Server to Server Applications`_ and create your service account. And
please generate a private key for the account.
.. _Google Client Libraries: Using OAuth 2.0 for Server to Server Applications`: https://developers.google.com/api-client-library/python/auth/service-accounts
Configure Sphinx
----------------
Add ``sphinxcontrib.googledrive`` to ``extensions`` at `conf.py`::
extensions += ['sphinxcontrib.googledrive']
And let the private key for your service account to Sphinx through one of
the following methods:
1. Set content of the private key via environment variable
`GOOGLE_DRIVE_SERVICE_ACCOUNT_KEY`::
$ export GOOGLE_DRIVE_SERVICE_ACCOUNT_KEY='{"type": "service_account", ...}'
2. Set a path to the private key file via `googledrive_service_account`
in `conf.py`::
googledrive_service_account = '/path/to/private.key'
Usage
=====
Please give an URL of caoo diagrams to image_ or figure_ directives
as an argument::
.. image:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
.. figure:: https://docs.google.com/drawings/d/1Q687-tVfqOMh86-16yl64misTee2bO5KPNuV5-LZ5FE/edit
caption of figure
.. _image: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image
.. _figure: http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure
Configuration Options
======================
**googledrive_service_account**
A path to private key for service account.
**googledrive_trim_images**
Trim white space or not (boolean).
Repository
==========
https://github.com/tk0miya/sphinxcontrib-googledrive
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-googledrive-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62871b7635e2da1f6a1a50aead3cfa7ce09df9d15318af9103ada0aed577ca83 |
|
MD5 | 10c3d3ca8b94cd5862d9cfcc2ccf7161 |
|
BLAKE2b-256 | 97ae8a696c7e4cde136d9f068ced40ad57ce507e8be00c88afe869e292644db2 |
Close
Hashes for sphinxcontrib_googledrive-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cb0975f48897f6220436ad6c283f3431dc77a6cd523aeb3d2d9ab6f73ae50a5 |
|
MD5 | 42b93ee89f996f0826787ee1556ee2f4 |
|
BLAKE2b-256 | cd73dd485fe1ba1cb482dae9c5cf5ccf43ab110109369bc523e4b24879fd70c7 |