{"id":20279789,"url":"https://github.com/genieframework/apidocs","last_synced_at":"2026-06-04T18:31:10.245Z","repository":{"id":190446108,"uuid":"613971936","full_name":"GenieFramework/APIDocs","owner":"GenieFramework","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-19T09:59:28.000Z","size":26,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-04T02:41:29.680Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Julia","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/GenieFramework.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":"2023-03-14T16:25:19.000Z","updated_at":"2024-09-19T09:59:31.000Z","dependencies_parsed_at":"2024-11-14T18:31:41.295Z","dependency_job_id":null,"html_url":"https://github.com/GenieFramework/APIDocs","commit_stats":null,"previous_names":["genieframework/apidocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GenieFramework/APIDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FAPIDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FAPIDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FAPIDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FAPIDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GenieFramework","download_url":"https://codeload.github.com/GenieFramework/APIDocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FAPIDocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33916320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-04T02:00:06.755Z","response_time":64,"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":[],"created_at":"2024-11-14T13:33:16.201Z","updated_at":"2026-06-04T18:31:10.125Z","avatar_url":"https://github.com/GenieFramework.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Genie Framework API Docs Generator\n\nThis project builds the API documentation for packages in the Genie Framework. It uses `Documenter.jl` to generate markdown files with docstrings for objects listed in each package's `src/API/` folder.\n\n## Packages Covered\n\nThe packages are listed in the `main.jl` script in the `package_info` variable. Each package has an url to download the source from, and an optional `docs_site_folder` field specifying the folder in the Genie docs site where the documentation should be placed.\n\n\n\n## Usage\n\nRequired Julia packages: ArgParse, Documenter, DocumenterMarkdown, LibGit2\n\nThe main script to run is `main.jl`. It accepts the following command-line arguments:\n\n- `--docs-site-root` or `-r`: Root folder for docs site documentation\n- `--output-folder` or `-o`: Base output folder for documentation (default: \"output/\")\n- `packages`: Names of the packages to generate the documentation for (optional)\n\nNote: You must specify either `--docs-site-root` OR `--output-folder`, but not both. If neither is specified, the default output folder \"output/\" will be used.\n\nExample usage:\n\n```\njulia main.jl --docs-site-root \"/path/to/docs/site\" Genie Stipple\n```\n\nThis will generate documentation for the Genie and Stipple packages and place it in the appropriate subdirectories of the specified docs site root.\n\nAlternatively:\n\n```\njulia main.jl --output-folder \"/path/to/output\" Genie Stipple\n```\n\nThis will generate documentation for the Genie and Stipple packages and place it in the specified output folder.\n\n## How It Works\n\n1. The script clones or updates the specified package repositories.\n2. It modifies the `make.jl` file in each package's docs folder to use `DocumenterMarkdown`.\n3. It runs the modified `make.jl` to generate the documentation.\n4. The generated documentation is processed to format warnings and create a `_dir.yml` file.\n5. The processed documentation is copied to the specified output location (either within the docs site structure or to the specified output folder).\n\n## Note on DocumenterMarkdown\n\nThis project uses a modified version of `DocumenterMarkdown.jl` to generate Markdown files in the format required for the Genie Framework documentation site. The modified version is available at [PGimenez/DocumenterMarkdown.jl](https://github.com/PGimenez/DocumenterMarkdown.jl).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenieframework%2Fapidocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenieframework%2Fapidocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenieframework%2Fapidocs/lists"}