2.28.0: sphinx warnings `reference target not found`
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 42/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、報告された sphinx-build -n -T -b man docs build/sphinx/man コマンドを実行し、requests/models.py、adapters.py、utils.py、cookies.py の参照を調査します。不足しているターゲットを、ドキュメント化されたオブジェクトおよび intersphinx の設定と比較します。関連する参照警告(無効な言語設定の警告を含む)が解消され、strict build でそれらが報告されなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
On building my packages I'm using sphinx-build command with -n switch which shows warmings about missing references. These are not critical issues.
Here is the output with warnings:
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v5.0.1
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).
making output directory... done
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://urllib3.readthedocs.io/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 15 added, 0 changed, 0 removed
reading sources... [100%] user/quickstart
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-requests.3 { user/install user/quickstart user/advanced user/authentication community/recommended community/faq community/out-there community/support community/vulnerabilities community/release-process community/updates api dev/contributing dev/authors } /home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/models.py:docstring of requests.models.Response.json:: WARNING: py:exc reference target not found: requests.exceptions.JSONDecodeError
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.BaseAdapter.send:3: WARNING: py:class reference target not found: PreparedRequest
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter:3: WARNING: py:class reference target not found: Session
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.add_headers:9: WARNING: py:class reference target not found: PreparedRequest
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.build_response:6: WARNING: py:class reference target not found: PreparedRequest
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.get_connection:: WARNING: py:class reference target not found: urllib3.ConnectionPool
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.request_url:10: WARNING: py:class reference target not found: PreparedRequest
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.send:3: WARNING: py:class reference target not found: PreparedRequest
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/adapters.py:docstring of requests.adapters.HTTPAdapter.send:: WARNING: py:class reference target not found: urllib3 Timeout object
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/utils.py:docstring of requests.utils.add_dict_to_cookiejar:: WARNING: py:class reference target not found: CookieJar
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/cookies.py:docstring of requests.cookies.cookiejar_from_dict:: WARNING: py:class reference target not found: CookieJar
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/cookies.py:docstring of collections.abc.MutableMapping.pop:: WARNING: py:class reference target not found: v, remove specified key and return the corresponding value.
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/cookies.py:docstring of collections.abc.MutableMapping.popitem:: WARNING: py:class reference target not found: (k, v), remove and return some (key, value) pair
/home/tkloczko/rpmbuild/BUILD/requests-2.28.0/requests/cookies.py:docstring of collections.abc.MutableMapping.setdefault:: WARNING: py:class reference target not found: D.get(k,d), also set D[k]=d if k not in D
done
build succeeded, 15 warnings.
You can peak on fixes that kind of issues in other projects
https://github.com/latchset/jwcrypto/pull/289
https://github.com/click-contrib/sphinx-click/commit/abc31069
https://github.com/latchset/jwcrypto/pull/289
https://github.com/RDFLib/rdflib-sqlalchemy/issues/95
https://github.com/sissaschool/elementpath/commit/bf869d9e
https://github.com/jaraco/cssutils/issues/21
- 主要言語
- Python
- スター
- 54.7k
- フォーク
- 10.8k
- 平均マージ
- 18分
- マージ済み PR(30日)
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
psf/requests のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
`iter_lines(decode_unicode=True, delimiter=<str>)` raises `TypeError` when `Response.encoding` is `None`再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
get_encoding_from_headers treats any content type containing 'text' as text/* (ISO-8859-1)対応中かも @suyashgitt が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
Invalid `params` type (e.g. int) raises misleading "TypeError: Cannot mix str and non-str arguments"オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
似ている issue
-
documentation type/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
add entry to blockオープン
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
StevenBlack/hosts#3299 ·
-
`garak --report` overwrites the input report when its name has no ".report"対応中かも @0z5a が今日担当しました。 オープンneeds-triage
難易度 2/5 半日 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
trace: Pi's 1-hour cache writes are priced at 1.25x, but billed at 2x対応中かも @Shizoqua が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
microsoft/TokenEconomizer#221 ·
メンテナーはふだん 1 日以内に返信
-
plot_graph crashes when a mesh node has no m2m edge対応中かも @tygvi が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
mllam/neural-lam#883 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信