ipython / ipython/traitlets

Generate manpage from configuration options

未关闭
#636 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
653
派生
217
平均合并
2 天 21 小时
30 天内合并 PR
2

描述

In https://github.com/jupyter/jupyter_server/issues/320, @SnarkBoojum submitted a manpage for Jupyter Server that largely encoded the results from `--help`. We realized that it would make more sense to have an automatically generated manpage at the traitlet level from the configurable traits. This issue is about adding a `--generate-manpage` option, or perhaps a separate manpage generation command, that does something similar to `-h`, but generates the output as a manpage.

贡献指南

打开贡献指南

调研方向

首先追踪可配置 trait 如何生成现有的 `-h` 输出,以及命令行选项或独立命令如何在 traitlet 层级接入。确定预期的接口是 `--generate-manpage` 还是独立命令,然后验证生成的输出是否以 manpage 形式包含可配置选项。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
cli
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。