Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

0.10.2: sphinx warnings `reference target not found`

未关闭
#192 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
38/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

使用 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 分钟
30 天内合并 PR
2

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

python-poetry/tomlkit 的其他 Issue

查看 python-poetry/tomlkit 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。