You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "AlenkaF (via GitHub)" <gi...@apache.org> on 2024/03/18 08:15:28 UTC
[I] [Python][Docs] API docs are broken for dev version [arrow]
AlenkaF opened a new issue, #40623:
URL: https://github.com/apache/arrow/issues/40623
### Describe the bug, including details regarding any error messages, version, and platform.
Development version of the docs seems to be broken for generated Python API Reference documentation.
Example: https://arrow.apache.org/docs/dev/python/generated/pyarrow.Schema.html
Did a hard refresh, hope it is not just me?
### Component(s)
Documentation, Python
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@arrow.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2003166829
cc @raulcd
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2014831597
The fix was merged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007304212
#40442 may be related...: https://github.com/apache/arrow/pull/40442#issuecomment-2007300966
But it has different result:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2017597663
Issue resolved by pull request 40739
https://github.com/apache/arrow/pull/40739
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2009862365
* https://github.com/sphinx-doc/sphinx/issues/12147
* https://github.com/sphinx-doc/sphinx/pull/12149
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007527358
> Oh... Does this solve?
That indeed seems to do the trick ..
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007480484
Oh... Does this solve?
```diff
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 7915e2c2c4..b67833112b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -208,8 +208,8 @@ templates_path = ['_templates']
#
source_suffix = {
- '.md': 'markdown',
'.rst': 'restructuredtext',
+ '.md': 'markdown',
}
autosummary_generate = True
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007396790
Starting to run the doc build locally, it seems that the issue is that the generated API files are now generated as .md files (but there content is restructuredtext).
With https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html it seems there is an option to specify which extension to use, but not sure how that can be tweaked from conf.py
It seems that adding `myst_parser` to the list of extensions has (unintended) effect on the default extension that sphinx uses for this ..
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF closed issue #40623: [Python][Docs] API docs are broken for dev version
URL: https://github.com/apache/arrow/issues/40623
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2006439067
This started with the update https://github.com/apache/arrow-site/commit/05cb617c8fe58ff90911945f5a25efa94695ba1f from the nightly build of 2024-03-12, so that matches the timeframe of potential candidate cause https://github.com/apache/arrow/pull/40442
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007383778
That looks like the same issue
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Python][Docs] API docs are broken for dev version [arrow]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on issue #40623:
URL: https://github.com/apache/arrow/issues/40623#issuecomment-2007512707
Hmm. Sphinx may have a problem:
```diff
diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py
index 22e616c3f..9a469d23e 100644
--- a/sphinx/ext/autosummary/__init__.py
+++ b/sphinx/ext/autosummary/__init__.py
@@ -770,7 +770,7 @@ class AutoLink(SphinxRole):
def get_rst_suffix(app: Sphinx) -> str | None:
def get_supported_format(suffix: str) -> tuple[str, ...]:
- parser_class = app.registry.get_source_parsers().get(suffix)
+ parser_class = app.registry.get_source_parsers().get(suffix.removeprefix('.'))
if parser_class is None:
return ('restructuredtext',)
return parser_class.supported
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org