Skip to content

[WIP]DOC: Fixed more warnings #20542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 4, 2018
+7 −7
Merged

[WIP]DOC: Fixed more warnings #20542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4189109
DOC: Fixed more warnings
TomAugspurger Mar 29, 2018
d42d71e
DOC: Add option to fail on error
TomAugspurger Mar 29, 2018
f0ed17d
Restore nbsphinx links
TomAugspurger Mar 30, 2018
230c29a
Fixed nb links
TomAugspurger Mar 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/source/merging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ and ``right`` is a subclass of DataFrame, the return type will still be

``merge`` is a function in the pandas namespace, and it is also available as a
``DataFrame`` instance method :meth:`~DataFrame.merge`, with the calling
``DataFrame `` being implicitly considered the left object in the join.
``DataFrame`` being implicitly considered the left object in the join.

The related :meth:`~DataFrame.join` method, uses ``merge`` internally for the
index-on-index (by default) and column(s)-on-index join. If you are joining on
Expand Down Expand Up @@ -1202,7 +1202,7 @@ Overlapping value columns
~~~~~~~~~~~~~~~~~~~~~~~~~

The merge ``suffixes`` argument takes a tuple of list of strings to append to
overlapping column names in the input ``DataFrame``s to disambiguate the result
overlapping column names in the input ``DataFrame``\ s to disambiguate the result
columns:

.. ipython:: python
Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.17.1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ We can render the HTML to get the following table.
:file: whatsnew_0171_html_table.html

:class:`~pandas.core.style.Styler` interacts nicely with the Jupyter Notebook.
See the :ref:`documentation <style.ipynb>` for more.
See the :doc:`documentation <style>` for more.

.. _whatsnew_0171.enhancements:

Expand Down
4 changes: 2 additions & 2 deletions doc/source/whatsnew/v0.20.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ For example, after running the following, ``styled.xlsx`` renders as below:
import os
os.remove('styled.xlsx')

See the :ref:`Style documentation <style.ipynb#Export-to-Excel>` for more detail.
See the :ref:`Style documentation </style.ipynb#Export-to-Excel>` for more detail.

.. _whatsnew_0200.enhancements.intervalindex:

Expand Down Expand Up @@ -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`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lost my comment.

Those should work, but newer nbsphinxes seem to have issues with them. I think spatialaudio/nbsphinx#174 is tracking this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ..)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mgeier Thanks for the input! So it should just be the slash that is missing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mgeier, somehow I read that note about the / multiple times and missed it :)

- :class:`pandas.io.formats.style.Styler` template now has blocks for easier extension, see the :ref:`example notebook </style.ipynb#Subclassing>` (:issue:`15649`)
- :meth:`Styler.render() <pandas.io.formats.style.Styler.render>` now accepts ``**kwargs`` to allow user-defined variables in the template (:issue:`15649`)
- Compatibility with Jupyter notebook 5.0; MultiIndex column labels are left-aligned and MultiIndex row-labels are top-aligned (:issue:`15379`)
- ``TimedeltaIndex`` now has a custom date-tick formatter specifically designed for nanosecond level precision (:issue:`8711`)
Expand Down
4 changes: 2 additions & 2 deletions doc/source/whatsnew/v0.23.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,6 @@ for storing ip addresses.
.. code-block:: ipython

In [3]: ser = pd.Series(values)
...:

In [4]: ser
Out[4]:
Expand All @@ -342,8 +341,9 @@ for storing ip addresses.
Notice that the dtype is ``ip``. The missing value semantics of the underlying
array are respected:

.. code-block:: ipython

In [5]: ser.isna()
...:
Out[5]:
0 True
1 False
Expand Down