Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement docs generator #2155

Closed
antonmedv opened this issue Sep 3, 2020 · 1 comment
Closed

Implement docs generator #2155

antonmedv opened this issue Sep 3, 2020 · 1 comment
Labels
Milestone

Comments

@antonmedv
Copy link
Member

This feature will be part of Deployer v7.

What should be done:

  • dep command dep docs [recipe-file-path.php]
  • output: Markdown

Idea:

  • Parse recipe and generate markdown docs.
  • The command takes a path to the recipe, parses PHP for comments and generates markdown.
  • What should be in generated markdown:
    • First comment of a file (aka description of recipe). Starting with /** or /* or //.
    • Each task('...') -> collect desc() and comment right before task.
    • Each set('..') -> as list of options as well as comment right before set.
    • Links to other required recipes.
@antonmedv antonmedv added this to the 7.0 milestone Sep 3, 2020
@antonmedv antonmedv changed the title Docs generator Implement docs generator Sep 3, 2020
@antonmedv
Copy link
Member Author

I did it myself.
47a193f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant