{"id":18613918,"url":"https://github.com/enthought/sectiondoc","last_synced_at":"2025-11-03T02:30:38.856Z","repository":{"id":2405224,"uuid":"3372631","full_name":"enthought/sectiondoc","owner":"enthought","description":"Default Repo description from terraform module","archived":false,"fork":false,"pushed_at":"2019-09-06T13:08:26.000Z","size":275,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-12-27T02:42:25.903Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enthought.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.txt","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-02-07T00:05:48.000Z","updated_at":"2021-06-01T17:12:35.000Z","dependencies_parsed_at":"2022-08-25T07:41:18.535Z","dependency_job_id":null,"html_url":"https://github.com/enthought/sectiondoc","commit_stats":null,"previous_names":["enthought/refactordoc"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsectiondoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsectiondoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsectiondoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enthought%2Fsectiondoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enthought","download_url":"https://codeload.github.com/enthought/sectiondoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239163793,"owners_count":19592406,"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":[],"created_at":"2024-11-07T03:24:20.619Z","updated_at":"2025-11-03T02:30:38.827Z","avatar_url":"https://github.com/enthought.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sectiondoc: Docstring section rendering sphinx extension\n========================================================\n\n.. image:: https://travis-ci.org/enthought/sectiondoc.svg?branch=master\n   :target: https://travis-ci.org/enthought/sectiondoc\n   :alt: Build status\n\n.. image:: http://codecov.io/github/enthought/sectiondoc/coverage.svg?branch=master\n   :target: http://codecov.io/github/enthought/sectiondoc?branch=master\n   :alt: Coverage status\n\n.. image:: https://readthedocs.org/projects/sectiondoc/badge/?version=latest\n   :target: http://sectiondoc.readthedocs.org/en/latest/?badge=latest\n   :alt: Documentation Status\n\n\nThe sectiondoc extension parses the function and class docstrings as\nthey are retrieved by the autodoc extension and renders the section\nblocks into sphinx friendly rst. The extension shares similarities\nwith alternatives (such as numpydoc) but aims at reflecting the\noriginal form of the docstring and support project specific\ncustomizations.\n\nKey features of **sectiondoc** are:\n\n    - Do not change the order of sections.\n    - Allow sphinx directives between (and inside) section blocks.\n    - Custom rendering styles\n\n.. note::\n\n       Sectiondoc should work with sphinx \u003e= 0.4 that provides\n       the ``autodoc-process-docstring`` hook.\n\n\nRepository\n----------\n\nThe sectiondoc extension lives at Github. You can clone the repository\nusing::\n\n    $ git clone https://github.com/enthought/sectiondoc.git\n\n\nInstallation\n------------\n\nInstall ``sectiondoc`` from pypi using pip::\n\n    $ pip install sectiondoc\n\nInstall the latest developing version using::\n\n    $ pip install git+https://github.com/enthought/sectiondoc.git#egg=sectiondoc\n\nUsage\n-----\n\n\nStyles can be selected by referencing in ``conf.py`` the module they are defined::\n\n    extensions = [\n        ...,\n        'sectiondoc.styles.legacy',\n        ...,\n    ]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Fsectiondoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenthought%2Fsectiondoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenthought%2Fsectiondoc/lists"}