search

mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications
https://pypi.org/project/mkdocs-click
Apache License 2.0
109 stars 16 forks source link

Support for language-agnostic documentation #56

Open pyhedgehog opened 2 years ago

pyhedgehog commented 2 years ago

I'm writing docs with i18n support. There are two places where it should be done:

  1. All docstrings of click-command functions and options help arguments. Like this: 
    @click.option('--quiet/--verbose', '-q/-v', flag_value=True, default=False, help=_("Disable processing output"))
@doc(_("""Help text of subcommand."""))
def subcommand(quiet):
...
  2. MkDocs docs directory. I'm using mkdocs-static-i18n plugin. So I've created index.XX.md for each supported language.

I want to pass different language code to mkdocs-click plugin in each cli.XX.md. I think it will includes reloading of module each time with changing LANG variable.

pyhedgehog commented 2 years ago

@DataDog, should I try to implement it and create pull request or you want to do it alone?

ofek commented 2 years ago

Feel free to open a PR!