Investigate ReadTheDocs to ease documentation readability

オープン

#180 2024年9月10日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 5/5
見積もり時間: 1週間以上
初心者へのやさしさ: 25/100

issue の種類: 機能追加
明瞭さ: 説明が足りない
活発さ: 停滞
技術スタック: python
領域: documentation

調査の方向性

ファイルやテストは指定されていません。まず、Sphinxで生成されたAPIドキュメントが現在どのようにGitHub Pagesで公開されているかを確認し、次にReadTheDocsのテーマとプラットフォームについて、バージョニングとホスティングのトレードオフを含めて調査してください。メリット、懸念事項、承認に向けた推奨案を文書化できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

Is there an existing issue for this?

I have searched the existing issues.

Please describe the feature you have in mind and explain what the current shortcomings are?

This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.

This could be investigated to assess the benefit/concerns.

How would you imagine the implementation of the feature?

No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..

Are there any labels you wish to add?

I have added the relevant labels to the enhancement request.

Describe alternatives you've considered:

No response

Additional context:

No response

主要言語: Python
スター: 16
フォーク: 15
平均マージ: 1日 9時間
マージ済み PR（30日）: 10

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

ynput/ayon-python-api のほかの issue

AttributeError when setting limit argument in get_activities オープン

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

ynput/ayon-python-api#351 · 2026年9月10日に作成
Custom GraphQlQuery using set_limit on nested edge field can result in the limit turning negative when querying オープン

難易度 3/5 1〜2日初心者へのやさしさ 68/100

ynput/ayon-python-api#350 · 2026年9月3日に作成
ServerAPI: Add method to add new attribute オープン

難易度 3/5 1〜2日初心者へのやさしさ 45/100

ynput/ayon-python-api#199 · 2024年11月12日に作成
Entity Hub: Refactor get children to work with added entity types support オープン

ynput/ayon-python-api#198 · 担当者 1 名 · 2024年10月28日に作成
Implement ayon uris endpoint オープン

難易度 2/5 1〜3時間初心者へのやさしさ 50/100

ynput/ayon-python-api#182 · 2024年9月18日に作成

ynput/ayon-python-api の issue をすべて見る

似ている issue

[BUG] GkeTpuCluster queries metadata.google.internal for MEGASCALE_SLICE_ID even when TPU_SKIP_MDS_QUERY is set オープン

難易度 2/5 1〜3時間初心者へのやさしさ 88/100

jax-ml/jax#40854 · 2026年9月22日に作成
[pcied] Honour PCIE_DETACH_INFO on platforms that are not smartswitches オープン

難易度 2/5 1〜3時間初心者へのやさしさ 82/100

sonic-net/sonic-platform-daemons#900 · 2026年9月21日に作成
MCP client has no httpx timeout, so the event stream fails after 5 seconds オープン

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

Azure/azure-functions-agents-runtime#228 · 2026年9月21日に作成
feat(mcp): friendlier error when `run_cloud_sync` is called on a disabled connection オープン

enhancement

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

airbytehq/PyAirbyte#1205 · 2026年9月21日に作成
pn7160: reader goes permanently deaf — post-read IRQ-low check fails reads that succeeded オープン

難易度 2/5 1〜3時間初心者へのやさしさ 74/100

esphome/esphome#19452 · 2026年9月21日に作成

Python の issue をもっと見る