Skip to content

DOC: api display #15632

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

Jump to bottom
Closed
jreback opened this issue Mar 9, 2017 · 2 comments
Closed

DOC: api display #15632

jreback opened this issue Mar 9, 2017 · 2 comments
Labels
Docs

Comments

@jreback
Copy link
Contributor

jreback commented Mar 9, 2017

our API page shows lots of useful information: http://pandas-docs.github.io/pandas-docs-travis/api.html and is pretty browsable.

But the toctree is mostly useless and encumbered by pandas.Sereies.rdiv which is pretty long (these tend to wrap).

So ideas to fix are:

  • limit toc tree depth (:maxdepth: 2) (we set to 4 higher)
  • try to find a way to control the title on the toc tree items
@jreback jreback added the Docs label Mar 9, 2017
@jreback jreback added this to the Next Major Release milestone Mar 9, 2017
@jreback
Copy link
Contributor Author

jreback commented Mar 9, 2017 •
edited
Loading

this might be fixed / ameliorted by #15556 so should explore that first. IOW maybe there is a more dynamic toctree possibility.

@datapythonista datapythonista mentioned this issue Jun 13, 2018
Closed
@mroeschke
Copy link
Member

it appears that the new api reference docs look pretty good https://pandas.pydata.org/pandas-docs/stable/reference/index.html

Going to close but happy to reopen if this doesn't look good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jreback @mroeschke