README.rst

Sphinxdoc DocuShare role

This is a quick and dirty approach to retrieve the document title and download URL for Docushare documents. The package is based on PyDocuShare.

Installation

Install the package from Github:

$ pip install git+https://github.com/olebole/sphinx-docushare

Configuration

Put the following to sphinxdocs conf.py:

extensions = [
    "sphinx_docushare",
]
docushare_baseurl = "https://example.com/docushare"
docushare_username = os.environ["DOCUSHARE_USERNAME"]
docushare_password = os.environ["DOCUSHARE_PASSWORD"]

Warning

Do not put your password to conf.py; this is a major security risk.

Usage

Then, you can use it to refer to documents and document versions by their id:

* :docushare:`Document-3725`
* :docushare:`Version-5760`

This creates links with the document title as text that points to the download URL of the document.