Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-101100: Remove roles of sample classes in howto/* #127084

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

koyuki7w
Copy link
Contributor

@koyuki7w koyuki7w commented Nov 21, 2024

Removed sphinx roles of some classes and methods, as the classes are defined in the sample codes, not in Python.

Fixed warnings:

howto/descriptor.rst:45: WARNING: py:class reference target not found: Ten [ref.class]
howto/descriptor.rst:218: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:218: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:256: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:340: WARNING: py:class reference target not found: Validator [ref.class]
howto/descriptor.rst:363: WARNING: py:class reference target not found: Validator [ref.class]
howto/descriptor.rst:363: WARNING: py:meth reference target not found: validate [ref.meth]
howto/descriptor.rst:372: WARNING: py:class reference target not found: OneOf [ref.class]
howto/descriptor.rst:374: WARNING: py:class reference target not found: Number [ref.class]
howto/descriptor.rst:378: WARNING: py:class reference target not found: String [ref.class]
howto/descriptor.rst:876: WARNING: py:class reference target not found: Field [ref.class]
howto/descriptor.rst:1143: WARNING: py:func reference target not found: Property [ref.func]
howto/enum.rst:78: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:90: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:113: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:131: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:576: WARNING: py:class reference target not found: Animal [ref.class]
howto/enum.rst:893: WARNING: py:class reference target not found: FloatEnum [ref.class]

📚 Documentation preview 📚: https://cpython-previews--127084.org.readthedocs.build/

Removed sphinx roles of some classes and methods,
as the classes are defined in the sample codes, not in Python.

Fixed warnings:
```
howto/descriptor.rst:45: WARNING: py:class reference target not found: Ten [ref.class]
howto/descriptor.rst:218: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:218: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:256: WARNING: py:class reference target not found: Person [ref.class]
howto/descriptor.rst:340: WARNING: py:class reference target not found: Validator [ref.class]
howto/descriptor.rst:363: WARNING: py:class reference target not found: Validator [ref.class]
howto/descriptor.rst:363: WARNING: py:meth reference target not found: validate [ref.meth]
howto/descriptor.rst:372: WARNING: py:class reference target not found: OneOf [ref.class]
howto/descriptor.rst:374: WARNING: py:class reference target not found: Number [ref.class]
howto/descriptor.rst:378: WARNING: py:class reference target not found: String [ref.class]
howto/descriptor.rst:876: WARNING: py:class reference target not found: Field [ref.class]
howto/descriptor.rst:1143: WARNING: py:func reference target not found: Property [ref.func]
howto/descriptor.rst:1725: WARNING: py:class reference target not found: Object [ref.class]
howto/enum.rst:78: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:90: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:113: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:131: WARNING: py:class reference target not found: Weekday [ref.class]
howto/enum.rst:576: WARNING: py:class reference target not found: Animal [ref.class]
howto/enum.rst:893: WARNING: py:class reference target not found: FloatEnum [ref.class]
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant