{"id":27966565,"url":"https://github.com/ternaus/google-docstring-2tsx","last_synced_at":"2025-12-30T15:07:03.449Z","repository":{"id":283751326,"uuid":"950315520","full_name":"ternaus/google-docstring-2tsx","owner":"ternaus","description":"Generate folder with markdown from google docstrings","archived":false,"fork":false,"pushed_at":"2025-04-04T01:36:43.000Z","size":53,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-04T14:47:43.013Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ternaus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"ternaus","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2025-03-18T01:08:17.000Z","updated_at":"2025-04-04T01:35:15.000Z","dependencies_parsed_at":"2025-03-22T00:36:55.264Z","dependency_job_id":null,"html_url":"https://github.com/ternaus/google-docstring-2tsx","commit_stats":null,"previous_names":["ternaus/google-docstring-2md"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fgoogle-docstring-2tsx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fgoogle-docstring-2tsx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fgoogle-docstring-2tsx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ternaus%2Fgoogle-docstring-2tsx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ternaus","download_url":"https://codeload.github.com/ternaus/google-docstring-2tsx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252949489,"owners_count":21830196,"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":"2025-05-07T20:19:34.357Z","updated_at":"2025-05-07T20:19:34.959Z","avatar_url":"https://github.com/ternaus.png","language":"Python","funding_links":["https://github.com/sponsors/ternaus"],"categories":[],"sub_categories":[],"readme":"# Google Docstring to TSX Converter\n\nA tool that converts Python package docstrings to TSX files for Next.js documentation, with a focus on generating beautiful, interactive documentation.\n\n## License\n\nThis software is licensed under a custom license agreement. The Albumentations Team and their official contributors have free access to use this software for their projects. All other users must obtain a paid license.\n\nFor licensing inquiries, please contact:\nVladimir Iglovikov (iglovikov@gmail.com)\n\nSee the [LICENSE](LICENSE) file for full details.\n\n## Features\n\n- Converts Google-style docstrings to TSX format with modern UI components\n- Preserves type information and parameter descriptions with syntax highlighting\n- Maintains the original package structure in the output\n- Generates source code with toggle functionality for each class/function\n- Supports both class and function documentation\n- Creates a table of contents for easy navigation\n- Handles module-level docstrings\n- Preserves code examples and formatting\n- Supports complex type definitions with interactive display\n- Generates responsive, dark-themed documentation\n\n## Installation\n\n```bash\npip install docstring2tsx\n```\n\n## Usage\n\n```bash\npython -m src.docstring2tsx.__main__ --package-name PACKAGE_NAME --output-dir OUTPUT_DIR\n```\n\nor:\n```bash\ndocstring2tsx --package-name PACKAGE_NAME --output-dir OUTPUT_DIR\n```\n\nThis will:\n1. Import the specified package\n2. Extract docstrings from all classes, functions, and modules\n3. Convert them to TSX format with modern UI components\n4. Create a directory structure matching the package\n5. Write TSX files for each module with proper routing\n\n## Output Structure\n\nThe tool creates a directory structure that matches the input package:\n\n```\noutput_dir/\n  module1/\n    page.tsx\n  module2/\n    submodule/\n      page.tsx\n```\n\nEach `page.tsx` file contains:\n- Module name and description in a styled container\n- Table of contents with links to classes and functions\n- Interactive source code display with toggle functionality\n- Parameter descriptions with type information\n- Return values and exceptions with proper formatting\n- Code examples with syntax highlighting\n- References and links to related documentation\n\n## Development\n\n```bash\n# Install dependencies\npip install -e .\n\n# Run tests\npytest\n\n# Run pre-commit hooks\npre-commit run --all-files\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fternaus%2Fgoogle-docstring-2tsx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fternaus%2Fgoogle-docstring-2tsx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fternaus%2Fgoogle-docstring-2tsx/lists"}