{"id":28521807,"url":"https://github.com/audiokit/docgen","last_synced_at":"2025-07-04T00:33:01.821Z","repository":{"id":57828823,"uuid":"526767902","full_name":"AudioKit/docgen","owner":"AudioKit","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-03T06:43:06.000Z","size":8385,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-09T08:15:24.118Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/AudioKit.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}},"created_at":"2022-08-19T22:30:58.000Z","updated_at":"2024-01-13T16:28:58.000Z","dependencies_parsed_at":"2023-01-17T20:02:55.090Z","dependency_job_id":null,"html_url":"https://github.com/AudioKit/docgen","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/AudioKit/docgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AudioKit%2Fdocgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AudioKit%2Fdocgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AudioKit%2Fdocgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AudioKit%2Fdocgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AudioKit","download_url":"https://codeload.github.com/AudioKit/docgen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AudioKit%2Fdocgen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263426311,"owners_count":23464795,"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-06-09T08:14:09.650Z","updated_at":"2025-07-04T00:33:01.806Z","avatar_url":"https://github.com/AudioKit.png","language":"Shell","readme":"# docgen\n\n`docgen` is a simple utility for generating documentation across AudioKit repositories. This allows us to keep our Vapor website lean without requiring large file storage, while also providing us with a local utility for seeing all of our documentation in one place.\n\n## Usage\n\n### Adding New Documentation\n\n1. Add the repository to the `Package.swift` just as you normally would.\n2. Add _each package product_ (could be one or multiple) you want to generate documentation for to the bottom of `scripts/docgen.sh`.\n\n### Generate Documentation\n\nTo generate documentation, simply clone this repository and run the following command:\n\n```sh\nscripts/generate.sh\n```\n\nThis example will generate a `.doccarchive` for all products defined in [`scripts/generate.sh`](/scripts/generate.sh) from their respective packages and output to the `./docs` directory.\n\nYou can change the output directory by calling:\n\n```sh\n./scripts/generate.sh \u003coutput_directory\u003e\n```\n\n### Preview Documentation\n\nThis hasn't gotten a lot of attention yet so it may be broken, but you can preview the documentation by running the following command:\n\n```sh\nscripts/preview.sh\n```\n\nThe command will output information on how to view it locally.\n\n## Additional Notes\n\nA standalone `Package.swift` in a repository without any `Sources` directory or `target` definitions is probably a weird sight. So why aren't we just passing URLs into a command and outputting the products?\n\nThat's definitely doable, but the `docgen` command takes advantage of Swift Package Manager and [swift-docc-plugin](https://github.com/apple/swift-docc-plugin) in order to ensure that:\n\n1. Packages resolve properly.\n2. Products are identified.\n3. Version control is provided to us.\n\nThere is a downside: this project's minimum deployment target would need to be raised if _any_ downstream dependency requires a higher deployment target.\n\nThis _should_ be fine, as this package should be run on CI/CD systems and not used for consumers. If we run into problems with it later on, we can always re-evaluate -- the tl;dr is that DocC generation and hosting is easy.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faudiokit%2Fdocgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faudiokit%2Fdocgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faudiokit%2Fdocgen/lists"}