Comments (4)
cc: @mansenfranzen
We can make a patch release to reinstate py_sig_re
. I would note, though, that it is a private object, and thus is not subject to any deprecation policies -- it is not documented anywhere and the regular expression contained therein is subject to change without notice (and indeed, has done so).
It would be better to find a supported and documented method for autodoc_pydantic
to achieve the same outcome.
A
from sphinx.
@j-carson thanks for taking care with this issue!
@AA-Turner it would be great if you could re-import the regular expression to allow older versions of autodoc_pydantic to work with the newest sphinx versions.
For the future, I would also like to rely on a public function/API instead of using the private regex. Are you aware of any? If not, I would be willing to provide a PR adding the rather narrow functionality wrapped in a publicly facing function.
from sphinx.
62c3bad will be included in Sphinx 7.3.7.
For the second, I will have a think. Perhaps it could be as simple as splitting the first few lines from handle_signature
and returning some custom type:
def split_object_signature(sig: str) -> _SigType:
m = py_sig_re.match(sig)
if m is None:
raise ValueError
prefix, name, tp_list, arglist, retann = m.groups()
return _SigType(...)
from sphinx.
Sphinx 7.3.7 has been released with fixes.
A
from sphinx.
Related Issues (20)
- v7.3 release breaks jupyterbook builds HOT 5
- Could not import extension sphinx.builders.changes: no module named tomli HOT 6
- Sphinx 7.3.0: ``furo`` errors (The 'furo' theme inherits from 'basic-ng', which is not a loaded theme) HOT 2
- v7.3.1 breaks the furo theme HOT 1
- sphinx~=7.3.0 breaks sphinx-immaterial HOT 5
- Sphinx >7.3.2 imports themes in env, even if not set via `html_theme` HOT 3
- Warning "cannot cache unpickable configuration value" when config contains a reference to a function HOT 12
- `.. csv-table::` directive erroneously expects quotes after `:delim:` in sphinx 7.3 HOT 3
- When I created my Function, I didn't have the "__ init__. py" file, which prevented me from generating Api documents HOT 1
- get_config fails with any section that is not 'theme' or 'options' HOT 4
- Extension sphinxcontrib-htmlhelp has typo
- [FR] `INCLUDE_PATTERN` for `apidoc`
- Move ``util.typing.restify()`` to ``autodoc`` HOT 1
- Outdated docker images HOT 3
- Remove the recommendation about the bundled package HOT 2
- Search summaries include unwanted anchor content
- [Documentation] mention the existence of the RST `.. code::` directive HOT 1
- Support LibreJS in HTML - machine readable license HOT 1
- Build time is increased by 6x after upgrading from `>=5.1.1` to `5.2.0+` HOT 5
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.