[Discussion] Docs rewrite
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 冷清
- 技术栈
- python
调研方向
Review the documentation on the gh-pages branch, the existing Markdown files, and the relevant .py files containing type hints and docstrings. Read the proposed Sphinx autodoc approach and assess how the documentation could be represented in reStructuredText while preserving publication to gh-pages. The issue does not define a specific migration scope or completion criteria.
由索引模型根据 Issue 内容生成。
描述
Currently, documentation is maintained on a separate branch, gh-pages, and written in Markdown. With all of the type hints that have been incorporated over the last few releases, IDE/LSP's will have better information about what function signatures are available and being used. Python's default way of making documentation available to users is through docstrings.
What I propose is that instead of separately maintaining the documentation, especially the user facing TSC API documentation, separately, that it be maintained through docstrings in the .py files. Then the markdown that is currently being used is converted to reStructuredText. This would open up the ability to use sphinx and its autodoc extension to read those docstrings and produce the web navigable documentation. I believe the docs could still be published to gh-pages, so URLs would not have to change.
.rst is definitely not as simple of a format as .md, but the ability to fetch docstrings and function signatures I think offers a clear advantage over continuing with markdown.
- 主要语言
- Python
- 星标
- 716
- 派生
- 446
- 平均合并
- 8 天 8 小时
- 30 天内合并 PR
- 2
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
tableau/server-client-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
tableau/server-client-python#1865 ·
-
in-progress
难度 2/5 1-3 小时 新手友好度 78/100
tableau/server-client-python#1829 · 1 条评论 ·
-
enhancement gap needs investigation
难度 2/5 1-3 小时 新手友好度 68/100
tableau/server-client-python#1322 · 1 条评论 ·
-
[Type2] Allow Incremental Refresh type schedules to be added via `server.schedules.add_to_schedule` 未关闭help wanted Server-Side Enhancement ui-exists
难度 2/5 1-3 小时 新手友好度 68/100
tableau/server-client-python#1101 · 3 条评论 ·
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 68/100
tableau/server-client-python#783 · 5 条评论 ·
查看 tableau/server-client-python 的全部 Issue
相似的 Issue
-
agent-ready documentation needs-triage
难度 1/5 1-3 小时 新手友好度 88/100
-
documentation
难度 1/5 1 小时以内 新手友好度 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
-
instance instance add
难度 1/5 1 小时以内 新手友好度 72/100
searxng/searx-instances#939 · 1 条评论 ·
-
area-deployment area-integrations triage:bot-seen
难度 2/5 半天 新手友好度 86/100