{"id":29356902,"url":"https://github.com/cesnet/sphinx-vhdl","last_synced_at":"2025-08-24T09:43:28.365Z","repository":{"id":65602931,"uuid":"390368604","full_name":"CESNET/sphinx-vhdl","owner":"CESNET","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-04T13:13:17.000Z","size":5627,"stargazers_count":23,"open_issues_count":7,"forks_count":9,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-07-09T05:44:09.718Z","etag":null,"topics":["documentation-generator","fpga","liberouter","sphinx","sphinx-extension","vhdl"],"latest_commit_sha":null,"homepage":"https://cesnet.github.io/sphinx-vhdl/","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/CESNET.png","metadata":{"files":{"readme":"README.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-28T13:51:39.000Z","updated_at":"2025-04-04T08:13:27.000Z","dependencies_parsed_at":"2025-04-03T07:31:45.841Z","dependency_job_id":"85c99b9d-27c2-4c36-bd7c-3667fa230f86","html_url":"https://github.com/CESNET/sphinx-vhdl","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/CESNET/sphinx-vhdl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CESNET%2Fsphinx-vhdl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CESNET%2Fsphinx-vhdl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CESNET%2Fsphinx-vhdl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CESNET%2Fsphinx-vhdl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CESNET","download_url":"https://codeload.github.com/CESNET/sphinx-vhdl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CESNET%2Fsphinx-vhdl/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267638628,"owners_count":24119764,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation-generator","fpga","liberouter","sphinx","sphinx-extension","vhdl"],"created_at":"2025-07-09T05:40:48.251Z","updated_at":"2025-07-29T06:04:00.420Z","avatar_url":"https://github.com/CESNET.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SPHINX-VHDL\n\n[![PyPI](https://img.shields.io/pypi/v/sphinx-vhdl)](https://pypi.org/project/sphinx-vhdl/)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CESNET/sphinx-vhdl/.github/workflows/doc.yml)](https://cesnet.github.io/sphinx-vhdl/)\n\n\u003e A [sphinx](https://www.sphinx-doc.org/) domain for semi-automatically documenting VHDL\n\nThis extension for Sphinx allows you to keep your documentation in code and automatically draw it out into your main documentation using just few simple directives.\n\nYou can see the detailed documentation at https://cesnet.github.io/sphinx-vhdl/, or build it yourself (running `make` while in the `doc` directory and having `sphinx` + `sphinx_rtd_theme` installed should be sufficient)\n\n## Usage\n\nThe python package must be installed with\n```shell\npip3 install sphinx-vhdl\n```\n\nThis extension requires Python \u003e= 3.8 and Sphinx \u003e= 6.0.0.\n\n*Note that your documentation may use multiple sphinx extensions or an alternative theme (such as `sphinx_rtd_theme`), which you must also have installed.*\n\n## Configuration\n\nIn your sphinx `conf.py` file add\n\n```python\nextensions = ['sphinxvhdl.vhdl']\nvhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'\n```\n\n## Where is the SPHINX-VHDL extension used?\n\n- [NDK-FPGA by CESNET](https://github.com/CESNET/ndk-fpga)\n- *Do you use SPHINX-VHDL in your public VHDL repository? Please add a link to this list!*\n\n## Repository maintainer\n\n- Jakub Cabal, cabal@cesnet.cz\n- Vladislav Válek, valekv@cesnet.cz\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcesnet%2Fsphinx-vhdl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcesnet%2Fsphinx-vhdl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcesnet%2Fsphinx-vhdl/lists"}