{"id":19642059,"url":"https://github.com/beanbaginc/beanbag-docutils","last_synced_at":"2025-04-28T12:31:48.400Z","repository":{"id":57414398,"uuid":"63396562","full_name":"beanbaginc/beanbag-docutils","owner":"beanbaginc","description":"Documentation utilities for Beanbag products.","archived":false,"fork":false,"pushed_at":"2024-07-29T10:39:44.000Z","size":156,"stargazers_count":5,"open_issues_count":2,"forks_count":4,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-08T01:53:55.344Z","etag":null,"topics":["python","sphinx","sphinx-doc","sphinx-extension"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beanbaginc.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-15T06:15:06.000Z","updated_at":"2024-07-23T00:08:39.000Z","dependencies_parsed_at":"2024-07-11T17:29:44.437Z","dependency_job_id":"7d712eae-2632-4c13-8f31-b17b417a3433","html_url":"https://github.com/beanbaginc/beanbag-docutils","commit_stats":{"total_commits":83,"total_committers":1,"mean_commits":83.0,"dds":0.0,"last_synced_commit":"0d3fed68c078b33243ef34258b5b33c87e0e9381"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beanbaginc%2Fbeanbag-docutils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beanbaginc%2Fbeanbag-docutils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beanbaginc%2Fbeanbag-docutils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beanbaginc%2Fbeanbag-docutils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beanbaginc","download_url":"https://codeload.github.com/beanbaginc/beanbag-docutils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224115711,"owners_count":17258238,"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":["python","sphinx","sphinx-doc","sphinx-extension"],"created_at":"2024-11-11T14:11:23.007Z","updated_at":"2024-11-11T14:11:23.921Z","avatar_url":"https://github.com/beanbaginc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=====================\nBeanbag Doc Utilities\n=====================\n\nThis is a collection of utilities to help with generating documentation for\nBeanbag-related products, including:\n\n* `Review Board`_ - Our widely-used open source code review product.\n* RBCommons_ - Our Review Board SaaS.\n* Djblets_ - A set of utilities and infrastructure for Django-based projects.\n* RBTools_ - Command line tools for Review Board and RBCommons.\n\n\n.. _Review Board: https://www.reviewboard.org/\n.. _RBCommons: https://www.rbcommons.com/\n.. _Djblets: https://github.com/djblets/djblets/\n.. _RBTools: https://github.com/reviewboard/rbtools/\n\n\nSphinx Extensions\n=================\n\nMost of the utilities are used with the Sphinx_ documentation system. Amongst\nother enhancements, this package offers:\n\n* A parser for the `Beanbag docstring format`_ (a variation on the `Google\n  docstring format`_), which we use for Python and JavaScript documentation\n* Enhancements for Sphinx's intersphinx_ system to provide per-page\n  intersphinx resolution options (useful for pages, such as release notes,\n  that need to link to different versions of the same docs, such as Django_ or\n  Python)\n* Enhancements to ReStructuredText references to let a reference name span\n  lines (useful for long Python/JavaScript module/class names)\n* Linking code references to GitHub documentation\n* High-DPI image embedding\n* A role for HTTP status codes\n* Access to document-defined metadata in a structured form when parsing\n  documents\n\n\n.. _Beanbag docstring format:\n   https://www.notion.so/reviewboard/Standard-Documentation-Format-4388f594d86547cc949b365cda3cf391\n.. _Django: https://www.djangoproject.com/\n.. _Google docstring format:\n   https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\n.. _intersphinx:\n   https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html\n.. _our products: https://www.beanbaginc.com/\n.. _ReStructuredText:\n   https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html\n.. _Sphinx: https://www.sphinx-doc.org/\n\n\nCompatibility\n=============\n\n* beanbag-docutils 3.x supports Python 3.8-3.13 and Sphinx 5.0-7.x.\n* beanbag-docutils 2.x supports Python 3.6-3.12 and Sphinx 1.8-7.x.\n* beanbag-docutils 1.x supports Python 2.7 and 3.6-3.10.\n\n\nGetting Started\n===============\n\nTo install the package, run:\n\n.. code-block:: shell\n\n   $ pip install beanbag-docutils\n\n\nSee the documentation_ for usage information.\n\n\n.. _documentation: https://beanbag-docutils.readthedocs.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeanbaginc%2Fbeanbag-docutils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeanbaginc%2Fbeanbag-docutils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeanbaginc%2Fbeanbag-docutils/lists"}