configurability #8
Replies: 1 comment 3 replies
-
Hi @rafalkrupinski, thanks for offering your help 🙂 You are definitely welcome to draft the feature design in a new issue first, so that we can discuss how it should be implemented, and once we agree you'll be able to send a PR (if you want to). My initial reaction is that I would prefer indeed the TOML format. I generally try to allow specifying the configuration within the following files, searched for in order:
The first one found takes precedence over the others. If we want to search in parent directories, we must climb up to the Git repository root and not higher (if any), and to the disk root if we're not in a Git repo (no other choice I believe). In all except some-setting = 0 In [tool.griffe2md]
some-setting = 0 Regarding Griffe itself, if you found configuration options that are not available through the CLI, please open new feature requests there (with use-cases) 🙂 |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
I see that internally both griffe and and the markdown generator are configurable, it's just not exposed in any way to the CLI user.
My personal favourite would be reading a yaml file via an option
-f path
, but other ways are possible too, like using toml file or even pyproject.toml (altho the latter would introduce requirement that greiffe2md works only on projects).I'm happy to contribute, just let me know if there's any preference @pawamoy
Beta Was this translation helpful? Give feedback.
All reactions