intel / intel/xml-cli

[FEATURE] Generate Dynamic Document generator and publish it

未关闭
#14 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation enhancement good first issue hacktoberfest help wanted
主要语言
Python
星标
32
派生
15
PR 合并指标
30 天内没有已合并 PR

描述

**Is your feature request related to a problem? Please describe.**
Generate Auto documentation generator

**Describe the solution you'd like**
1. Documentation from source code docstring should be generated automatically
2. Also should include documentation from markdown files maintained
3. Generated documentation should be part of Workflow automation process
4. (Optional) Create end-point to host the generated document (i.e. gitbook, github pages)

贡献指南

打开贡献指南

调研方向

No files, tests, or entry points are named. Start by locating how source-code docstrings, Markdown files, and workflow automation are currently organized, then define the generated-document output and publishing target. Done means documentation is generated from both sources, integrated into workflow automation, and optionally hosted through the selected endpoint.

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

评估

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

把新 issue 发到你的邮箱

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