Comments (2)
picnixz
commented on June 12, 2024
1
Thank you for what you found. I'll update my issue tomorrow.
EDIT: I've included your issues in mine so I'll hide your comment. Thank you!
from sphinx.
electric-coder
commented on June 12, 2024
These are the issue I could find that relate to types not linking correctly where the cause is plain processing of annotations in signatures or docstrings.
None and Optional not linking correctly:
Using optional as keyword misidentified as type:
Literal types not linking correctly:
Returns section types not linking:
Yield section types not linking correctly:
Generic types not linking:
Alias of generic and parameterized types:
TypeVar not linking:
TYPE_CHECKING specific:
@dataclass specific linking bugs:
@property return type:
(maybe a regression of the older - #8004)
autodoc mixing up data types:
this issue is somewhat of a miscellaneous:
General alias linking problems:
Napoleon specific:
from sphinx.
Related Issues (20)
- Error in sphinx.ext.napoleon 'autodoc-process-docstring' threw an exception (exception: 'bool' object has no attribute 'get') HOT 3
- A class with a `__setattr__` method raising an exception cannot be rendered by Sphinx's autodoc HOT 1
- Search bar disappears from pytest documentation upgrading from v5.3.0 to v7.2.6 and v6.2.1 HOT 1
- Force multi-line rendering of signatures at the directive level.
- Autosummary shows function signature in modules group when importing function of same name
- Recursive autosummary does not pass all options
- Config option `python_display_short_literal_types` not working HOT 1
- Minify css and js HOT 2
- Autosummary lists functions but does not generate documentation pages HOT 3
- New line and line-brack doesn't work in cnfluance. HOT 10
- `objects.inv` is not generated deterministically when there are duplicate references HOT 3
- add_css = getattr(app, "add_css_file", app.add_stylesheet) HOT 3
- <short description for the feature>
- Unify docutils type annotations HOT 11
- Intersphinx cannot link to section headers with uppercase names HOT 8
- Add toc entry autofunction
- pre_border-radius not translating to latexpdf for .. warning HOT 7
- Imported string constant has wrong docstring of `str` HOT 4
- In autosummary, expose complete objtype information to templates HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx.