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

A Sphinx extension for generating API documentation without importing the API.

readthedocs/sphinx-autoapi は初心者に優しい?

readthedocs/sphinx-autoapi への外部コントリビューターの PR が最近は少なく、どのくらいマージされるかはまだ言えません。 初心者向けのオープンな issue は今はありません。下の一覧に、このリポジトリのほかの issue があります。

スター
496
フォーク
151
オープンの初心者向け issue
0
索引済み issue
59
主要言語
Python
ライセンス
MIT
最終 GitHub push
2026年8月23日
最新の索引
2026年9月19日
コントリビューションガイド
コントリビューションガイドがありません
行動規範
行動規範がありません
初心者向けラベル
good first issue
PR マージ指標
30日以内にマージされた PR はありません

readthedocs/sphinx-autoapi にコントリビュートするには

  1. コントリビューションガイドはないので、README と最近マージされた PR をいくつか読んで、変更の出し方をつかみましょう。
  2. このプロジェクトには dev container があります。Codespaces で開くと、ブラウザですぐに開発環境が手に入ります。
  3. あなたのコントリビュートはプロジェクトの MIT ライセンスで公開されます。
  4. リポジトリをフォローすれば、新しい初心者向け issue が出たときにわかります。下のほかの issue も見てみましょう。
issue を読み込んでいます

誰かが対応中かもしれないイシューは最後に並べています。 すべて日付順に表示

  • First overload of functions with multiple overloads in .pyi files fail to appear in resultant .html
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 48/100

    readthedocs/sphinx-autoapi#557 · コメント 2 件 ·

  • PEP695 generic type syntax interpretion as cross-reference
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#552 ·

  • Types from attrs.define classes not shown in description
    オープン

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

    readthedocs/sphinx-autoapi#551 · コメント 1 件 · リアクション 1 件 ·

  • `imported-members` and `show-inheritance` leads to broken links
    オープン

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

    readthedocs/sphinx-autoapi#546 ·

  • WARNING: Unknown type: placeholder
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#540 · コメント 6 件 ·

  • Adding better support for pydantic models
    オープン

    難易度 5/5 1週間以上 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#529 · コメント 3 件 · リアクション 1 件 ·

  • `add_module_names = False` doesn't affect toctrees, only the body
    オープン

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

    readthedocs/sphinx-autoapi#527 · コメント 2 件 · リアクション 1 件 ·

  • Indirect imports not supported
    オープン
    Needed: Design Decision

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

    readthedocs/sphinx-autoapi#524 · コメント 1 件 ·

  • Show source from private modules
    オープン
    Needed: Reproduction Case

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

    readthedocs/sphinx-autoapi#515 · コメント 2 件 ·

  • 3.4.0 borks inheritance diagrams of classes with `namedtuple` class variables
    オープン

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

    readthedocs/sphinx-autoapi#505 · コメント 1 件 ·

  • Custom Template - Something is not working at all
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 25/100

    readthedocs/sphinx-autoapi#494 ·

  • Option to disable docstring inheritance
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 38/100

    readthedocs/sphinx-autoapi#489 · コメント 3 件 · リアクション 4 件 ·

  • Add a template for testing
    オープン

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

    readthedocs/sphinx-autoapi#487 ·

  • Intersphinx typehints are not properly parsed
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 38/100

    readthedocs/sphinx-autoapi#483 · コメント 1 件 · リアクション 1 件 ·

  • Sphinx Build fails on `AttributeError: 'AssignName' object has no attribute 'getattr'`
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#480 · コメント 2 件 ·

  • [Bug] Not working with `lazy-loader`
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#479 ·

  • Sphinx AutoAPI >=3.2 generates duplicate definitions of class attributes
    オープン

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

    readthedocs/sphinx-autoapi#476 · コメント 9 件 · リアクション 1 件 ·

  • References to hidden members remain unresolved when a documented alternative exists
    オープン

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

    readthedocs/sphinx-autoapi#469 ·

  • add documentation for availability and differences for `autodoc-process-docstring` (and some friends)
    オープン

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

    readthedocs/sphinx-autoapi#468 ·

  • Duplicated annotations in class and __init__() with autodoc typehints
    オープン

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

    readthedocs/sphinx-autoapi#461 · リアクション 1 件 ·

  • Hook for modifying method signatures
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#459 · コメント 8 件 ·

  • Griffe backend
    再び着手できるかも @AWhetter が 581 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン

    readthedocs/sphinx-autoapi#444 · コメント 5 件 · リアクション 1 件 · 担当者 1 名 ·

  • Remove Attributes + classes show no description
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#443 · コメント 3 件 ·

  • Parses first element of if __name__ == '__main__' block
    オープン

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

    readthedocs/sphinx-autoapi#429 ·

  • Enable strict type checking
    オープン

    難易度 5/5 1週間以上 初心者へのやさしさ 25/100

    readthedocs/sphinx-autoapi#425 ·

  • Allow finer-grained control over display of inherited members
    オープン

    難易度 5/5 1週間以上 初心者へのやさしさ 25/100

    readthedocs/sphinx-autoapi#417 · コメント 5 件 · リアクション 3 件 ·

  • Implementing a nightly build worklfow
    オープン

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

    readthedocs/sphinx-autoapi#416 ·

  • How to sort TOC entries
    オープン

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

    readthedocs/sphinx-autoapi#413 ·

  • Make imported memebrs link to their documentation.
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#411 · コメント 3 件 · リアクション 1 件 ·

  • Wrong namespace resolution for base clases when using star import
    オープン

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

    readthedocs/sphinx-autoapi#404 · コメント 1 件 ·

  • Support PEP-702 style deprecations
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 42/100

    readthedocs/sphinx-autoapi#401 · コメント 8 件 · リアクション 1 件 ·

  • Ambiguous type references when classes share the same name
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#395 ·

  • A module attribute with a value declared separately from its type is documented twice
    オープン

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

    readthedocs/sphinx-autoapi#387 ·

  • Configure a bug report template
    オープン

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

    readthedocs/sphinx-autoapi#386 ·

  • Write a contribution guide
    オープン

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

    readthedocs/sphinx-autoapi#385 ·

  • Support of incremental builds?
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#380 · コメント 1 件 ·

  • `more than one target found for cross-reference` warning appeared after upgrading to `sphinx==5.2.3` and `sphinx-autoapi>=2.0.0`
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 30/100

    readthedocs/sphinx-autoapi#357 · コメント 1 件 ·

  • Add header before module contents docs when showing summaries
    オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 38/100

    readthedocs/sphinx-autoapi#351 · リアクション 2 件 ·

  • Add pound colon #: parsing
    オープン
    Language: Python

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

    readthedocs/sphinx-autoapi#344 · コメント 8 件 · リアクション 10 件 ·

  • `autoapimodule` directive in "manual mode": Imported members are documented
    オープン
    Language: Python

    難易度 4/5 3〜5日 初心者へのやさしさ 32/100

    readthedocs/sphinx-autoapi#342 · コメント 2 件 ·

  • `duplicate object description` when redefing variable with `if` block
    再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#335 · コメント 2 件 · リアクション 1 件 ·

  • Strange warning in autosummary when literal block notation is used in first line of docstring
    オープン

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

    readthedocs/sphinx-autoapi#327 ·

  • Directive `.. autoapiclass` does not respect `autoapi_member_order = "bysource"`
    オープン
    Language: Python

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

    readthedocs/sphinx-autoapi#325 · リアクション 2 件 ·

  • Excluding directories
    オープン
    Good First Issue

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

    readthedocs/sphinx-autoapi#312 · コメント 4 件 · リアクション 2 件 ·

  • Full name not resolved correctly for class not imported from real source
    オープン
    Language: Python Needed: Design Decision

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

    readthedocs/sphinx-autoapi#310 · コメント 2 件 · リアクション 1 件 ·

  • Module table of contents are poorly formatted when long type hints are present
    オープン

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

    readthedocs/sphinx-autoapi#305 · コメント 2 件 · リアクション 3 件 ·

  • Python `module.rst` top-level section headers get eaten by Sphinx
    オープン
    Needed: Reproduction Case

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#302 · コメント 3 件 ·

  • Implicit namespace packages do not generate documentation
    オープン
    Language: Python

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

    readthedocs/sphinx-autoapi#298 · コメント 8 件 · リアクション 7 件 ·

  • Parse "non constant" attribute values
    オープン
    Language: Python

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#296 · リアクション 1 件 ·

  • Extendable templates?
    オープン
    Needed: Design Decision

    難易度 4/5 3〜5日 初心者へのやさしさ 35/100

    readthedocs/sphinx-autoapi#288 · コメント 2 件 ·

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

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