0.10.2: sphinx warnings `reference target not found`
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
sphinx-build -n -T -b man docs build/sphinx/man で報告を再現し、その後、tomlkit/init.py、tomlkit/items.py、tomlkit/toml_document.py にある参照対象の docstring と、ドキュメント設定を調査します。ビルドで報告された missing-reference、duplicate-description、および _static の欠落に関する警告が出なくなれば完了です。
索引モデルが 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 v4.5.0
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [100%] quickstart
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items:1: WARNING: duplicate object description of tomlkit.items, other instance in api, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.string:7: ERROR: Unknown target name: "https://toml.io/en/v1.0.0#string".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... tomlkit.1 { quickstart api } /home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dump:: WARNING: py:class reference target not found: collections.abc.Mapping
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dump:: WARNING: py:obj reference target not found: typing.IO
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.dumps:: WARNING: py:class reference target not found: collections.abc.Mapping
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/__init__.py:docstring of tomlkit.api.load:: WARNING: py:obj reference target not found: typing.IO
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.toml_document.TOMLDocument:1: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.add:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.append:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.clear:: WARNING: py:class reference target not found: None. Remove all items from D.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.copy:: WARNING: py:class reference target not found: a shallow copy of D
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.get:: WARNING: py:class reference target not found: D[k] if k in D, else d. d defaults to None.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.items:: WARNING: py:class reference target not found: a set-like object providing a view on D's items
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.keys:: WARNING: py:class reference target not found: a set-like object providing a view on D's keys
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.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/tomlkit-0.10.2/tomlkit/toml_document.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/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.remove:: WARNING: py:class reference target not found: tomlkit.container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of tomlkit.container.Container.setdefault:: WARNING: py:class reference target not found: D.get(k,d), also set D[k]=d if k not in D
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.MutableMapping.update:: WARNING: py:class reference target not found: None. Update D from mapping/iterable E and F.
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/toml_document.py:docstring of collections.abc.Mapping.values:: WARNING: py:class reference target not found: an object providing a view on D's values
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.AoT:1: WARNING: py:class reference target not found: tomlkit.items._CustomList
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Array:1: WARNING: py:class reference target not found: tomlkit.items._CustomList
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.BoolType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Date:1: WARNING: py:class reference target not found: datetime.date
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Date.replace:: WARNING: py:class reference target not found: datetime.date
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime:1: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.astimezone:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.astimezone:: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.DateTime.replace:: WARNING: py:class reference target not found: datetime.datetime
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.InlineTable:: WARNING: py:class reference target not found: container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.InlineTable:1: WARNING: py:class reference target not found: tomlkit.items.AbstractTable
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Key:1: WARNING: py:class reference target not found: abc.ABC
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.KeyType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.StringType:1: WARNING: py:class reference target not found: enum.Enum
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Table:: WARNING: py:class reference target not found: container.Container
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Table:1: WARNING: py:class reference target not found: tomlkit.items.AbstractTable
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time:: WARNING: py:class reference target not found: datetime.tzinfo
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time:1: WARNING: py:class reference target not found: datetime.time
/home/tkloczko/rpmbuild/BUILD/tomlkit-0.10.2/tomlkit/items.py:docstring of tomlkit.items.Time.replace:: WARNING: py:class reference target not found: datetime.time
done
build succeeded, 41 warnings.
- 主要言語
- Python
- スター
- 850
- フォーク
- 163
- 平均マージ
- 13分
- マージ済み PR(30日)
- 2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
python-poetry/tomlkit のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
python-poetry/tomlkit#546 · コメント 2 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
python-poetry/tomlkit#603 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
python-poetry/tomlkit#580 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
python-poetry/tomlkit#577 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
python-poetry/tomlkit#574 · コメント 5 件 ·
python-poetry/tomlkit の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
xinnan-tech/xiaozhi-fde-talk#263 ·
-
rules
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
huggingface/Repo2RLEnv#163 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
huggingface/sentence-transformers#4074 ·
-
comp/dashboard invalid P3
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
NousResearch/hermes-agent#121143 ·