https://github.com/olebole/sphinx-docushare

Sphinx extension to auto-create links to DocuShare documents
https://github.com/olebole/sphinx-docushare

docushare docushare-api python

Last synced: 11 months ago
JSON representation

Sphinx extension to auto-create links to DocuShare documents

• Host: GitHub
• URL: https://github.com/olebole/sphinx-docushare
• Owner: olebole
• License: bsd-3-clause
• Created: 2023-02-24T08:40:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-24T09:51:36.000Z (over 3 years ago)
• Last Synced: 2025-03-18T22:38:53.610Z (over 1 year ago)
• Topics: docushare, docushare-api, python
• Language: Python
• Homepage:
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
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:

.. code-block:: shell-session

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

Configuration

-------------

Put the following to sphinxdocs ``conf.py``:

.. code-block:: python

    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:

.. code-block:: ReST

    * :docushare:`Document-3725`

    * :docushare:`Version-5760`

This creates links with the document title as text that points to the

download URL of the document.