{"id":19132448,"url":"https://github.com/taichi-dev/docstring-gen","last_synced_at":"2025-05-06T18:14:53.887Z","repository":{"id":42634215,"uuid":"389129813","full_name":"taichi-dev/docstring-gen","owner":"taichi-dev","description":"Workflow for generating the docstring website","archived":false,"fork":false,"pushed_at":"2023-05-08T02:51:07.000Z","size":44,"stargazers_count":4,"open_issues_count":6,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-06T18:14:48.743Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taichi-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-24T15:16:36.000Z","updated_at":"2024-02-04T09:40:24.000Z","dependencies_parsed_at":"2024-11-09T06:18:29.079Z","dependency_job_id":"ca46789b-49c5-4f89-aedb-811167f2fbf8","html_url":"https://github.com/taichi-dev/docstring-gen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi-dev%2Fdocstring-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi-dev%2Fdocstring-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi-dev%2Fdocstring-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi-dev%2Fdocstring-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taichi-dev","download_url":"https://codeload.github.com/taichi-dev/docstring-gen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252741473,"owners_count":21797027,"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-09T06:18:19.629Z","updated_at":"2025-05-06T18:14:53.865Z","avatar_url":"https://github.com/taichi-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"We use the Sphinx toolchain to transform the Python docstrings into HTMLs. This is as simple as:\n\n1. Set `TAICHI_PATH` to the root of the Taichi repo.\n2. Run the following:\n\n    ```sh\n    pip install -r requirements.txt\n    cd experimental/\n    make html\n    ```\n\n3. Then go to `_build/html` and open `index.html` in your browser, i.e. `open _build/html/index.html`.\n\n# References\n\n* [sphinx-autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html): This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way.\n* [sphinx.ext.napoleon](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html): This is for parsing the Google-style (Numpy-style as well) Python docstring.\n* [sphinx-rtd-theme](https://sphinx-rtd-theme.readthedocs.io/en/stable/): Additional Sphinx themes.\n* [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi): \"real\" auto-generation of APIs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaichi-dev%2Fdocstring-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaichi-dev%2Fdocstring-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaichi-dev%2Fdocstring-gen/lists"}