{"id":18008290,"url":"https://github.com/clemapfel/autodocs.jl","last_synced_at":"2026-01-18T06:10:39.513Z","repository":{"id":122576536,"uuid":"540159572","full_name":"Clemapfel/autodocs.jl","owner":"Clemapfel","description":"Automatically generate Documentation for your Julia Package. (for lazy developers only)","archived":false,"fork":false,"pushed_at":"2022-09-22T21:17:49.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T19:51:16.971Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"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/Clemapfel.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":"2022-09-22T20:31:49.000Z","updated_at":"2022-09-22T20:32:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"b5dbbd00-e708-42b8-8bd2-5c16113a8219","html_url":"https://github.com/Clemapfel/autodocs.jl","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/Clemapfel%2Fautodocs.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clemapfel%2Fautodocs.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clemapfel%2Fautodocs.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clemapfel%2Fautodocs.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Clemapfel","download_url":"https://codeload.github.com/Clemapfel/autodocs.jl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247174403,"owners_count":20896074,"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-10-30T01:18:13.293Z","updated_at":"2026-01-18T06:10:39.504Z","avatar_url":"https://github.com/Clemapfel.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# autodocs.jl \n\nProvides the `@autodocs` macro, which, if invoked at the start of a module declaration, will generate basic documentation for all declared Julia objects (functions, structs, macros, etc.) in that module. If an object already has documentation, it will be expanded (but not overwritten). \n\nThis allows lazy developers to raise their documentation level to the bare minimum, while more motivated developers can skip writing all the boilerplate and stick to the actual description of objects and their functionality\n\n# Features\n+ output can be used with `Documenter.jl`\n+ documentation style can be configured\n+ hand-written documentation \n\n# Usage\n\n```julia\n# undocumented_file.jl\n\n@autodocs module UndocumentedModule \n\n  struct UndocumentedStruct\n    _private_field::Any\n    public_field\n  end\n  export UndocumentedStruct\n\n  function undocumented_function(x::T) where {T \u003c: Number}\n    # ...\n  end\n  export undocumented_function\n  \n  # do foo\n  function partially_documented_function(x; kwarg_01 = 1234)\n    # ...\n  end\n  #no export\n  \n  const global_variable = # ...\n  export global_variable\nend\n\n```\nGenerates:\n\n```julia\n# documented_file.jl\n\n\"\"\"\n`UndocumentedModule` (module)\n\n# Exports\n\n## Structs\n+ `UndocumentedStruct`\n\n## Functions\n+ `undocumented_function`\n\n## Variables\n+ `global_variable::Any`\n\"\"\"\nmodule UndocumentedModule\n\n  \"\"\"\n  `UndocumentedStruct` (immutable)\n  \n  ## Public Members\n  + `public_field::Any`\n  \n  ## Constructors\n  + `UndocumentedStruct(_private_field::Any, public_field::Any)`\n  \"\"\"\n  struct UndocumentedStruct\n    _private_field::Any\n    public_field\n  end\n  export undocumented_struct\n\n  \"\"\"\n  `undocumented_function(x \u003c: Number) -\u003e Any`\n  \n  ## Arguments\n  + `x \u003c: Number` \n  \"\"\"\n  function undocumented_function(x::T) where {T \u003c: Number}\n    # ...\n  end\n  export undocumented_function\n  \n  \"\"\"\n  `partially_documented_function(x::Any, [kwarg_01 = 1234]) -\u003e Any`\n  \n  ## Brief\n  do foo\n  \n  ## Arguments\n  + `x :: Any`\n  + `kwarg_01 = 1234`` [optional]\n  \"\"\"\n  function partially_documented_function(x; kwarg_01 = 1234)\n    # ...\n  end\n  \n  \"\"\"\n  `global_variable::Any` (const)\n  \"\"\"\nend\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclemapfel%2Fautodocs.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclemapfel%2Fautodocs.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclemapfel%2Fautodocs.jl/lists"}