Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

move generic docs stuff to `scverse-doc`?

クローズ
#78 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

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

調査の方向性

まず #60 の変更を読み、scverse-doc とあわせて既存の scverse-misc ドキュメントサポートを確認します。提案されている依存関係と拡張機能の読み込み方法を比較し、汎用的なドキュメント機能をどこに配置すべきか、またユーザーがどのように有効化すべきかを定義します。

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

説明

OK, so scverse-doc now almost exists. Should we move generic docs stuff there? E.g. some or all of what was added in #60 is not related to any runtime feature scverse-misc offers.

I wonder how we should handle it:

should scverse-doc depend on scverse-misc[sphinx] and load its extension? Then people could choose:

  • dependency-groups.docs = [ "scverse-doc" ] and extensions = ["scverse_doc"] gives them all scverse-doc features and all the scverse-misc features they activate in their project.dependencies
  • dependency-groups.docs = [ "scverse-doc" ] and extensions = ["scverse_doc.foo"] gives them only the subextensions they want (like scanpydoc)
  • dependency-groups.docs = [ "scverse-misc" ] and extensions = ["scverse_misc.sphinx_ext"] give them just docs support for the runtime features, no additional docs features

but we’ve already deviated from that with #60 …

主要言語
Python
スター
6
フォーク
2
平均マージ
3時間 11分
マージ済み PR(30日)
8

環境構築

はじめの一歩

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

scverse/scverse-misc のほかの issue

scverse/scverse-misc の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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