Skip to content
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

DOC: splitting the IO docs into separate pages #10446

Open
jorisvandenbossche opened this issue Jun 26, 2015 · 6 comments
Open

DOC: splitting the IO docs into separate pages #10446

jorisvandenbossche opened this issue Jun 26, 2015 · 6 comments

Comments

@jorisvandenbossche
Copy link
Member

The documentation on the extensive pandas IO tools is currently one big page: http://pandas.pydata.org/pandas-docs/stable/io.html.

I propose to split this in several files: a page with a general introduction to the IO tools, and then one page per format (writer/reader combo).
(this could be seen as a first start for #6000)

Splitting this shouldn't be that hard (I was just a bit experimenting if it would be possible to keep git blame working for all splitted files, but not that important probably ..), but an issue I would like to get some feedback for: What do we do with all existing links? How do we keep them working?

Anybody who has some experience with such issues when restructuring a website what the best way is to deal with this?

@anateresamunoz
Copy link

Hi! I will try to solve this :)

@jackgoldsmith4
Copy link
Contributor

Hi @jorisvandenbossche is this still something that needs working on? It seems like the docs have changed a lot since the creation of this issue.

@mroeschke mroeschke removed this from the Contributions Welcome milestone Oct 13, 2022
@sbadillo
Copy link

sbadillo commented Dec 6, 2022

Hi, I'll be happy to take on this restructuration. I'll aim to split the long User Guide > I/O page (https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html) as initially suggested into several pages:

  • A first introductory page. => what do you think of adding Other file formats and Performance considerations sections here ?
  • 20 pages, one per reader/writer combo.

I will aim to do the nesting like in the other big sections : e.g.
image

Let me know if this is still relevant.

@cobaltt7
Copy link
Contributor

cobaltt7 commented Oct 4, 2023

take

@Aakanksha3010
Copy link

take

@cobaltt7 cobaltt7 removed their assignment Oct 23, 2023
@cobaltt7
Copy link
Contributor

I'm unable to successfully build the docs due to ipython/ipython#11200.

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

No branches or pull requests

10 participants