{"id":16874186,"url":"https://github.com/olebole/sphinx-docushare","last_synced_at":"2025-07-19T20:10:26.415Z","repository":{"id":185199880,"uuid":"605943980","full_name":"olebole/sphinx-docushare","owner":"olebole","description":"Sphinx extension to auto-create links to DocuShare documents","archived":false,"fork":false,"pushed_at":"2023-02-24T09:51:36.000Z","size":3,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T22:38:53.610Z","etag":null,"topics":["docushare","docushare-api","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/olebole.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-02-24T08:40:45.000Z","updated_at":"2023-09-26T13:50:41.000Z","dependencies_parsed_at":"2023-08-01T03:52:05.899Z","dependency_job_id":null,"html_url":"https://github.com/olebole/sphinx-docushare","commit_stats":null,"previous_names":["olebole/sphinx-docushare"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/olebole/sphinx-docushare","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olebole%2Fsphinx-docushare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olebole%2Fsphinx-docushare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olebole%2Fsphinx-docushare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olebole%2Fsphinx-docushare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olebole","download_url":"https://codeload.github.com/olebole/sphinx-docushare/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olebole%2Fsphinx-docushare/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266004323,"owners_count":23862930,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docushare","docushare-api","python"],"created_at":"2024-10-13T15:30:18.685Z","updated_at":"2025-07-19T20:10:26.052Z","avatar_url":"https://github.com/olebole.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinxdoc DocuShare role\n========================\n\nThis is a quick and dirty approach to retrieve the document title and\ndownload URL for Docushare documents. The package is based on\n`PyDocuShare \u003chttps://tmtsoftware.github.io/cont-pydocushare\u003e`_.\n\n\nInstallation\n------------\n\nInstall the package from Github:\n\n.. code-block:: shell-session\n\n    $ pip install git+https://github.com/olebole/sphinx-docushare\n\n\nConfiguration\n-------------\n\nPut the following to sphinxdocs ``conf.py``:\n\n.. code-block:: python\n\n    extensions = [\n\t\"sphinx_docushare\",\n    ]\n    docushare_baseurl = \"https://example.com/docushare\"\n    docushare_username = os.environ[\"DOCUSHARE_USERNAME\"]\n    docushare_password = os.environ[\"DOCUSHARE_PASSWORD\"]\n\n.. warning::\n\n   Do not put your password to ``conf.py``; this is a major\n   security risk.\n\n\nUsage\n-----\n\nThen, you can use it to refer to documents and document versions by their id:\n\n.. code-block:: ReST\n\n    * :docushare:`Document-3725`\n    * :docushare:`Version-5760`\n\nThis creates links with the document title as text that points to the\ndownload URL of the document.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folebole%2Fsphinx-docushare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folebole%2Fsphinx-docushare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folebole%2Fsphinx-docushare/lists"}