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

feat: Introduce digging behaviour #98

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Commits on Dec 29, 2023

  1. feat: Introduce digging behaviour

    This may be needed when the project has not such flat structure, as
    nixpkgs. When different libraries produces their outputs not at
    toplevel, but dipper.
    
    You may specify common templates to dig into in command arguments. Eg
    `--dig submodule`, then this will generate documentation for files like:
    
     {
       submodule = {...}: {
         /* Doc for foo */
         foo = 1;
         /* Doc for bar */
         bar = 2;
       }
     }
    
    You may force documentation to dig into attrset withing its comment to
    with `DocDig!` directive:
    
     {
       /* DocDig! */
       myDeepLib = {...}: {
         /* Doc for foo */
         foo = 1;
         /* Doc for bar */
         bar = 2;
       }
     }
    
    Change-Id: I1518323d8e09a087a7b7d02451437792f5bee98f
    ein-shved committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    9c920aa View commit details
    Browse the repository at this point in the history