ynput / ynput/ayon-python-api

Investigate ReadTheDocs to ease documentation readability

オープン
#180 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

説明

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

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

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

はじめの一歩

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

調査の方向性

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

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

評価

技術スタック
python
領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。