Skip to content

Commit

Permalink
Reorganize cuDF Python docs (#10691)
Browse files Browse the repository at this point in the history
This PR is composed of two high-level changes:

* Replaces the use of ReStructuredText with [MyST Markdown](https://myst-parser.readthedocs.io/en/latest/). I used [rst2myst](https://github.com/executablebooks/rst2myst) for this and it worked pretty well. The rationale for this change is simple: we use `myst-nb` to render notebooks into documentation, and for consistency, it's nice to use `myst-parser` to parse the rest of our docs too. As a matter of opinion, I think Markdown is simpler and more familiar to most developers.

* Reorganizes the docs (see below):

Prior to this PR, the cuDF documentation was divided into 3 sections:

* A user guide
* A "Basics" section
* API reference

The distinction between the first two sections was never clear. I've gone ahead and merged those into a single section named "User Guide". This is also more consistent with Pandas.

This PR also makes a couple of other changes:

- Renamed the "Basics" page under the previous "Basics" section to "Data Types", as that reflects its contents more accurately. I also modified the content here a bit.
- Renamed the "10 minutes to CuPy and CuDF" notebook to "Interoperability between CuPy and CuDF" as that more accurately describes what that page is about.

----

Compare the TOC from this PR (below) with our [currently published docs](https://docs.rapids.ai/api/cudf/stable/).

<img width="710" alt="Screen Shot 2022-04-20 at 1 13 04 PM" src="https://user-images.githubusercontent.com/3190405/164286913-2e3bfd2a-caa7-4324-9cad-bd131058999f.png">

Authors:
  - Ashwin Srinath (https://github.com/shwina)
  - Mike McCarty (https://github.com/mmccarty)
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)
  - Mike McCarty (https://github.com/mmccarty)
  - Bradley Dice (https://github.com/bdice)

URL: #10691
  • Loading branch information
shwina authored May 4, 2022
1 parent 0d11591 commit dd68db3
Show file tree
Hide file tree
Showing 23 changed files with 1,738 additions and 1,283 deletions.
8 changes: 7 additions & 1 deletion docs/cudf/source/_static/params.css
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,17 @@ table.io-supported-types-table thead{

}

/* Used to make special-table scrollable when it overflows */
.special-table-wrapper {
width: 100%;
overflow: auto !important;
}

.special-table td, .special-table th {
border: 1px solid #dee2e6;
}

/* Needed to resolve https://github.com/executablebooks/jupyter-book/issues/1611 */
/* Needed to resolve https://github.com/executablebooks/jupyter-book/issues/1611 */
.output.text_html {
overflow: auto;
}
4 changes: 0 additions & 4 deletions docs/cudf/source/basics/PandasCompat.rst

This file was deleted.

62 changes: 0 additions & 62 deletions docs/cudf/source/basics/basics.rst

This file was deleted.

107 changes: 0 additions & 107 deletions docs/cudf/source/basics/dask-cudf.rst

This file was deleted.

Loading

0 comments on commit dd68db3

Please sign in to comment.