Open hexane360 opened 1 year ago
Interested in opening a PR to fix those?
I could give it a shot, but it would take a couple days to get around to. With sphinx, it's either a really simple fix or a PITA...
I just ran into this today. I think Polars is explicitly disabling cross-referencing on DataFrame because it is listed as :noindex:
. There's some detail at https://github.com/sphinx-doc/sphinx/issues/7052 . I think we just want :noindexentry:
instead which permits cross-referencing while still eliding the documented thing from the index.
Sadly autodoc does not support :noindexentry: https://github.com/sphinx-doc/sphinx/issues/10222. The only way forward is for polars to not use :noindex:
in its autodoc entries. This may result in duplicate entries if, for example, Polars creates multiple entries for DataFrame
in its docs.
Polars version checks
[X] I have checked that this issue has not already been reported.
[X] I have confirmed this bug exists on the latest version of Polars.
Issue description
I am trying to write documentation which references
polars
data types (py:class:polars.DataFrame
,py:class:polars.Series
, andpy:class:polars.Expr
). However, references to these aren't currently exported in polars' objects.inv (at https://pola-rs.github.io/polars/py-polars/html/objects.inv). Would it be possible to add references to these for use by downstream libraries?Reproducible example
Expected behavior
$ wget https://pola-rs.github.io/polars/py-polars/html/objects.inv $ python -m sphinx.ext.intersphinx objects.inv | egrep 'polars.DataFrame(?:\s)' polars.DataFrame reference/dataframe/index.html $ python -m sphinx.ext.intersphinx objects.inv | egrep 'polars.Series(?:\s)' polars.Series reference/series/index.html
Installed versions