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.

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

[docs] sphinx design 1/n #34625

Merged
merged 7 commits into from
Apr 21, 2023
Merged

[docs] sphinx design 1/n #34625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2c71cc4
add design
maxpumperla Apr 20, 2023
beeef8d
activate design
maxpumperla Apr 20, 2023
422ba6e
air tabs
maxpumperla Apr 20, 2023
11db5b5
grids and buttons
maxpumperla Apr 20, 2023
ee1dbcd
wrap up poc
maxpumperla Apr 20, 2023
6c20c3f
relax build reqs for now
maxpumperla Apr 21, 2023
59f4df7
add todo
maxpumperla Apr 21, 2023
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
3 changes: 2 additions & 1 deletion ci/ci.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,8 @@ build_sphinx_docs() {
if [ "${OSTYPE}" = msys ]; then
echo "WARNING: Documentation not built on Windows due to currently-unresolved issues"
else
FAST=True make html
# TODO: revert to "make html" once "sphinx_panels" plugin is fully removed.
FAST=True make develop
Copy link
Contributor Author

@maxpumperla maxpumperla Apr 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

this is slightly risky, will revert this after N/N for this migration. the two plugins in question currently clash and throw a warning. Note that this only suppresses warnings, not errors.

pip install datasets==2.0.0
RAY_MOCK_MODULES=0 RAY_DEDUP_LOGS=0 make doctest
fi
Expand Down
1 change: 1 addition & 0 deletions doc/requirements-doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ sphinxcontrib-redoc==1.6.0
sphinx-tabs==3.4.0
sphinx-remove-toctrees==0.0.3
autodoc_pydantic==1.6.1
sphinx_design==0.4.1

# MyST
myst-parser==0.15.2
Expand Down
3 changes: 2 additions & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@

extensions = [
"callouts", # custom extension from _ext folder
"sphinx_panels",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
Expand All @@ -58,6 +57,8 @@
"sphinxcontrib.redoc",
"sphinx_tabs.tabs",
"sphinx_remove_toctrees",
"sphinx_panels",
"sphinx_design",
]

# Prune deep toc-trees on demand for smaller html and faster builds.
Expand Down
98 changes: 58 additions & 40 deletions doc/source/data/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,50 +17,68 @@ modalities and types. Here you will find a few end-to-end examples of some basic
processing with Ray Data on tabular data, text (coming soon!), and imagery (coming
soon!).

.. panels::
:container: container pb-4
:column: col-md-4 px-2 py-2
:img-top-cls: pt-5 w-75 d-block mx-auto

---
:img-top: /images/taxi.png

+++
.. link-button:: nyc_taxi_basic_processing
:type: ref
:text: Processing the NYC taxi dataset
:classes: btn-link btn-block stretched-link
---
:img-top: /images/taxi.png

+++
.. link-button:: batch_training
:type: ref
:text: Batch Training with Ray Data
:classes: btn-link btn-block stretched-link
---
:img-top: /images/ocr.jpg

+++
.. link-button:: ocr_example
:type: ref
:text: Scaling OCR with Ray Data
:classes: btn-link btn-block stretched-link
.. grid:: 3
:gutter: 2
:class-container: container pb-4

.. grid-item-card::
:img-top: /images/taxi.png
:class-img-top: pt-5 w-75 d-block mx-auto

+++
.. button-ref:: nyc_taxi_basic_processing
:ref-type: doc
:color: primary
:outline:
:expand:

Processing the NYC taxi dataset

.. grid-item-card::
:img-top: /images/taxi.png
:class-img-top: pt-5 w-75 d-block mx-auto

+++
.. button-ref:: batch_training
:ref-type: doc
:color: primary
:outline:
:expand:

Batch Training with Ray Data

.. grid-item-card::
:img-top: /images/ocr.jpg
:class-img-top: pt-5 w-75 d-block mx-auto

+++
.. button-ref:: ocr_example
:ref-type: doc
:color: primary
:outline:
:expand:

Scaling OCR with Ray Data



Other Examples
--------------

.. panels::
:container: container pb-4
:column: col-md-4 px-2 py-2
:img-top-cls: pt-5 w-75 d-block mx-auto

---
:img-top: ../images/datastream-arch.svg
.. grid:: 3
:gutter: 2
:class-container: container pb-4

.. grid-item-card::
:img-top: ../images/datastream-arch.svg
:class-img-top: pt-5 w-75 d-block mx-auto

+++
.. button-ref:: random-access
:ref-type: doc
:color: primary
:outline:
:expand:

+++
.. link-button:: random-access
:type: ref
:text: Random Data Access (Experimental)
:classes: btn-link btn-block stretched-link
Random Data Access (Experimental)
Loading