[
https://issues.apache.org/jira/browse/ARROW-16567?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Alenka Frim updated ARROW-16567:
--------------------------------
Description:
Sphinx Copybutton configuration set in
[docs/source/conf.py|https://github.com/apache/arrow/blob/90aac16761b7dbf5fe931bc8837cad5116939270/docs/source/conf.py#L94-L96]
should be updated to ignore Ipython propmt text in examples that use IPython
directive, example:
[https://arrow.apache.org/docs/python/dataset.html|https://arrow.apache.org/docs/python/dataset.html#dataset-discovery]
See:
[https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers]
This can be changed once the work on
https://issues.apache.org/jira/browse/ARROW-13159 will be done.
was:
Sphinx Copybutton configuration set in
[docs/source/conf.py|https://github.com/apache/arrow/blob/90aac16761b7dbf5fe931bc8837cad5116939270/docs/source/conf.py#L94-L96]
should be updated to ignore Ipython propmt text in examples that use IPython
directive, example:
[https://arrow.apache.org/docs/python/dataset.html#dataset-discovery]
See:
https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers
This can be changed once the work on
https://issues.apache.org/jira/browse/ARROW-13159 will be done.
> [Doc][Python] Sphinx Copybutton should ignore IPython prompt text
> ------------------------------------------------------------------
>
> Key: ARROW-16567
> URL: https://issues.apache.org/jira/browse/ARROW-16567
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation, Python
> Reporter: Alenka Frim
> Priority: Major
> Labels: beginner, good-first-issue
> Fix For: 9.0.0
>
>
> Sphinx Copybutton configuration set in
> [docs/source/conf.py|https://github.com/apache/arrow/blob/90aac16761b7dbf5fe931bc8837cad5116939270/docs/source/conf.py#L94-L96]
> should be updated to ignore Ipython propmt text in examples that use IPython
> directive, example:
> [https://arrow.apache.org/docs/python/dataset.html|https://arrow.apache.org/docs/python/dataset.html#dataset-discovery]
> See:
> [https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers]
> This can be changed once the work on
> https://issues.apache.org/jira/browse/ARROW-13159 will be done.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
