8000 Is there a way to generate docs for all packages in a project · Issue #90 · princjef/gomarkdoc · GitHub
[go: up one dir, main page]

Skip to content

Is there a way to generate docs for all packages in a project #90

Open

Description

@githoober

Assuming a tree-like package organization exists in a project, is there a way to generate documentation for all of them with a root index file?

Activity

  1. princjef commented on Jun 11, 2023

    @princjef
    Owner

    Hi @githoober, you can generate a single document or a tree of documents for the packages in a repository with the tool today via ./... and the -output flag (omit {{.Dir}} to collapse docs into one file).

    There is no way to generate a root file that points at all generated documentation files, but it should be feasible to add. If you're interested in sending a PR for the change I'll consider adding it in. A hand-written root index file may also be reasonable depending on your use case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0