Skip to content

Include one file in multiple locations in recursive mode #794

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

Open
kevcube opened this issue Aug 21, 2024 · 0 comments
Open

Include one file in multiple locations in recursive mode #794

kevcube opened this issue Aug 21, 2024 · 0 comments

Comments

@kevcube
Copy link

kevcube commented Aug 21, 2024

What problem are you facing?

I am using --recursive to generate documentation for a main module and submodules, but I want all docs to include the same header/footer.

Currently if I define a path to this file in my configuration with footer-from: docs/footer.md, it works for the primary README.md but errors in submodules. I would like to have some kind of global import where this file is included in all recursive documentation generation.

How could terraform-docs help solve your problem?

Maybe with an additional configuration to footer-from: / header-from:, or if the file is not found in recursive mode, the main directory is checked for the existence of this file.

@kevcube kevcube changed the title Include one file in recursive mode Include one file in multiple locations in recursive mode Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant