Skip to content

DOC: pandas.NA repeated on website #53404

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.

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

Closed
DeaMariaLeon opened this issue May 26, 2023 · 5 comments · Fixed by #54821
Closed

DOC: pandas.NA repeated on website #53404

DeaMariaLeon opened this issue May 26, 2023 · 5 comments · Fixed by #54821
Assignees
Labels

Comments

@DeaMariaLeon
Copy link
Member

The link to pandas.NA can be found 3 times on the web's leftsidebar -
Please see pic.

It seems related to PR #48455 @mroeschke

pandas NA

@MarcoGorelli FYI

@mroeschke mroeschke added the Docs label May 26, 2023
@jadelsoufi
Copy link

Hey, I am interested in taking the issue but I don't have much knowledge in web development.
It seems like this rst file is the web page script
https://github.com/pandas-dev/pandas/blob/main/doc/source/reference/arrays.rst?plain=1

Here's where I think the code repeats the pandas.NA 3 times, could you confirm?

`
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

Int8Dtype
Int16Dtype
Int32Dtype
Int64Dtype
UInt8Dtype
UInt16Dtype
UInt32Dtype
UInt64Dtype
NA

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

Float32Dtype
Float64Dtype
NA

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

BooleanDtype
NA
`

@MarcoGorelli
Copy link
Member

yup, that's right! maybe it's OK to make a separate section (say, called "Missing values") in which you just say that NA is the way to represent missing values for nullable dtypes (see below)? Then, in that section, you just include the link to NA

@jadelsoufi
Copy link

take

@jadelsoufi
Copy link

I tried to build the documentation locally with sphinx but I get this error :

WARNING: ources... [  1%] getting_started/intro_tutorials/04_plotting          ts
>>>-------------------------------------------------------------------------
Warning in C:\Users\jadel\Documents\myfirstcontribution\pandas\doc\source\getting_started\intro_tutorials\04_plotting.rst at block ending on line 70
Specify :okwarning: as an option in the ipython:: block to suppress this message
----------------------------------------------------------------------------
<ipython-input-6-1eb00ff78cf2>:1: UserWarning: Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the figure.
  plt.show()
<<<-------------------------------------------------------------------------

Exception occurred:
  File "C:\Users\jadel\micromamba\envs\pandas-dev\lib\site-packages\IPython\sphinxext\ipython_directive.py", line 600, in process_input
    raise RuntimeError('Non Expected warning in `{}` line {}'.format(filename, lineno))
RuntimeError: Non Expected warning in `C:\Users\jadel\Documents\myfirstcontribution\pandas\doc\source\getting_started\intro_tutorials\04_plotting.rst` line 70

Is this matplotlib error normal when building html with sphinx ? Should I change matplotlib backend or is there another solution ?
The error says "Specify :okwarning: as an option in the ipython:: block to suppress this message" but I'm not really sure if changing the doc code is a good idea

@DeaMariaLeon
Copy link
Member Author

Hi @jadelsoufi we didn't see your comment earlier. Don't hesitate to ping us if you want to make sure we read you.

Do you want to open a PR so we can see what you tried?
Also, once the CI builds the documentation, you could write a comment with this (and nothing else): /preview
This way you can see your changes as the whole website is built.

And not, that matplotlib error is not normal. I don't think you need to change the backend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants