[WIP]DOC: Fixed more warnings #20542
Conversation
Upstream issue with linking to section headers in nbsphinx.
| @@ -499,7 +499,7 @@ Other Enhancements | |||
| - ``DataFrame.to_excel()`` has a new ``freeze_panes`` parameter to turn on Freeze Panes when exporting to Excel (:issue:`15160`) | |||
| - ``pd.read_html()`` will parse multiple header rows, creating a MutliIndex header. (:issue:`13434`). | |||
| - HTML table output skips ``colspan`` or ``rowspan`` attribute if equal to 1. (:issue:`15403`) | |||
| - :class:`pandas.io.formats.style.Styler` template now has blocks for easier extension, :ref:`see the example notebook <style.ipynb#Subclassing>` (:issue:`15649`) | |||
There was a problem hiding this comment.
From what I read in https://nbsphinx.readthedocs.io/en/0.3.2/a-normal-rst-file.html#links-to-notebooks-ye-olde-way, the above should actually work? Or should it be a relative link? (../style.ipynb) I think there is value in being able to reference the subsection
There was a problem hiding this comment.
Lost my comment.
Those should work, but newer nbsphinxes seem to have issues with them. I think spatialaudio/nbsphinx#174 is tracking this.
There was a problem hiding this comment.
We can also pin nbsphinx to 0.3.1 (the new release breaking this is only from last day)
(but not sure if that is worth it for this one link ..)
There was a problem hiding this comment.
If you use :ref:-style links, the link has to be relative to the base source directory and it has to start with as slash (since version 0.3.0, see https://github.com/spatialaudio/nbsphinx/blob/master/NEWS.rst and the link mentioned above, look at the "Note" section in the end).
This is a breaking change between 0.3.0 and older versions.
AFAICT, the issue spatialaudio/nbsphinx#174 is not related to :ref:-style links. It's a problem with re-writing "normal" reST links and its interactions with the "plot directive" from matplotlib (but it might also appear with other extensions?).
There was a problem hiding this comment.
@mgeier Thanks for the input! So it should just be the slash that is missing.
There was a problem hiding this comment.
Thanks @mgeier, somehow I read that note about the / multiple times and missed it :)
Codecov Report
@@ Coverage Diff @@
## master #20542 +/- ##
==========================================
+ Coverage 91.81% 91.84% +0.02%
==========================================
Files 152 152
Lines 49259 49260 +1
==========================================
+ Hits 45229 45242 +13
+ Misses 4030 4018 -12
Continue to review full report at Codecov.
|
remove error changes
|
I've removed the changes to the DocBuilder with the errors since I haven't been able to get it working yet. I'll try again once we're error free. |
|
Merging. Down to 2 warnings now. |
|
The warnings sound very much like spatialaudio/nbsphinx#174, feel free to contribute there. |
|
Ah, interesting, I'll take a look. In this case the files really may not exist, since we don't do the PDF builds on our CI. |
|
@TomAugspurger I assume the warning is caused by this: pandas/doc/source/index.rst.template Lines 7 to 9 in 6d610a4 ... which would be exactly the same case as spatialaudio/nbsphinx#174. |
Also trying to fail on warnings. I think it's not working yet.