Skip to content

Commit 9af8f11

Browse files
authored
Revert "[docs] Clean up doc structure (first part) (ray-project#21667)" (ray-project#21763)
This reverts commit 38e46c9.
1 parent 9009376 commit 9af8f11

File tree

456 files changed

+802
-941
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

456 files changed

+802
-941
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,10 @@ scripts/nodes.txt
115115
**/MNIST_data/
116116
**/cifar-10-batches-bin/
117117

118-
118+
# Generated documentation files
119+
/doc/_build
120+
/doc/source/_static/thumbs
121+
/doc/source/tune/generated_guides/
119122

120123
# User-specific stuff:
121124
.idea/**/workspace.xml

doc/.gitignore

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1 @@
1-
# Generated documentation files
2-
_build
3-
source/_static/thumbs
4-
5-
source/ray-core/examples/
6-
source/ray-tune/tutorials/
7-
source/ray-tune/generated_guides/
8-
source/ray-data/examples/
1+
auto_examples/

doc/BUILD

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
py_test(
99
name = "dask_xgboost",
1010
size = "medium",
11-
main = "source/ray-core/_examples/dask_xgboost/dask_xgboost.py",
12-
srcs = ["source/ray-core/_examples/dask_xgboost/dask_xgboost.py"],
11+
main = "examples/dask_xgboost/dask_xgboost.py",
12+
srcs = ["examples/dask_xgboost/dask_xgboost.py"],
1313
tags = ["exclusive", "team:ml", "py37"],
1414
args = ["--smoke-test", "--address ''", "--num-actors 4",
1515
"--cpus-per-actor 1", "--num-actors-inference 4",
@@ -20,8 +20,8 @@ py_test(
2020
py_test(
2121
name = "modin_xgboost",
2222
size = "medium",
23-
main = "source/ray-core/_examples/modin_xgboost/modin_xgboost.py",
24-
srcs = ["source/ray-core/_examples/modin_xgboost/modin_xgboost.py"],
23+
main = "examples/modin_xgboost/modin_xgboost.py",
24+
srcs = ["examples/modin_xgboost/modin_xgboost.py"],
2525
tags = ["exclusive", "team:ml", "py37"],
2626
args = ["--smoke-test", "--address ''", "--num-actors 4",
2727
"--cpus-per-actor 1", "--num-actors-inference 4",
@@ -31,77 +31,77 @@ py_test(
3131
py_test(
3232
name = "big_data_ingestion",
3333
size = "small",
34-
srcs = ["source/ray-data/_examples/big_data_ingestion.py"],
34+
srcs = ["source/data/_examples/big_data_ingestion.py"],
3535
tags = ["exclusive", "team:core", "py37"]
3636
)
3737

3838
py_test(
3939
name = "datasets_train",
4040
size = "medium",
41-
srcs = ["source/ray-core/_examples/datasets_train/datasets_train.py"],
41+
srcs = ["examples/datasets_train/datasets_train.py"],
4242
tags = ["exclusive", "team:ml", "py37", "datasets_train"],
4343
args = ["--smoke-test", "--num-workers=2", "--use-gpu"]
4444
)
4545

4646
py_test(
4747
name = "plot_hyperparameter",
4848
size = "small",
49-
srcs = ["source/ray-core/_examples/plot_hyperparameter.py"],
49+
srcs = ["examples/plot_hyperparameter.py"],
5050
tags = ["exclusive", "team:ml"]
5151
)
5252

5353
py_test(
5454
name = "plot_parameter_server",
5555
size = "medium",
56-
srcs = ["source/ray-core/_examples/plot_parameter_server.py"],
56+
srcs = ["examples/plot_parameter_server.py"],
5757
tags = ["exclusive", "team:ml"]
5858
)
5959

6060
py_test(
6161
name = "plot_pong_example",
6262
size = "large",
63-
srcs = ["source/ray-core/_examples/plot_pong_example.py"],
63+
srcs = ["examples/plot_pong_example.py"],
6464
tags = ["exclusive", "team:ml"]
6565
)
6666

6767
py_test(
6868
name = "progress_bar",
6969
size = "small",
70-
srcs = ["source/ray-core/_examples/progress_bar.py"],
70+
srcs = ["examples/progress_bar.py"],
7171
tags = ["exclusive", "team:ml"]
7272
)
7373

7474

75-
# Directory: source/ray-core/_examples/doc_code
75+
# Directory: examples/doc_code
7676
py_test(
7777
name = "doc_code_tf_example",
7878
size = "small",
79-
main = "source/ray-core/_examples/doc_code/tf_example.py",
80-
srcs = ["source/ray-core/_examples/doc_code/tf_example.py"],
79+
main = "examples/doc_code/tf_example.py",
80+
srcs = ["examples/doc_code/tf_example.py"],
8181
tags = ["exclusive", "tf", "team:ml"]
8282
)
8383

8484
py_test(
8585
name = "doc_code_torch_example",
8686
size = "small",
87-
main = "source/ray-core/_examples/doc_code/torch_example.py",
88-
srcs = ["source/ray-core/_examples/doc_code/torch_example.py"],
87+
main = "examples/doc_code/torch_example.py",
88+
srcs = ["examples/doc_code/torch_example.py"],
8989
tags = ["exclusive", "pytorch", "team:ml"]
9090
)
9191

9292
py_test(
9393
name = "doc_code_metrics_example",
9494
size = "small",
95-
main = "source/ray-core/_examples/doc_code/metrics_example.py",
96-
srcs = ["source/ray-core/_examples/doc_code/metrics_example.py"],
95+
main = "examples/doc_code/metrics_example.py",
96+
srcs = ["examples/doc_code/metrics_example.py"],
9797
tags = ["exclusive", "team:serve"]
9898
)
9999

100100
py_test(
101101
name = "doc_code_runtime_env_example",
102102
size = "small",
103-
main = "source/ray-core/_examples/doc_code/runtime_env_example.py",
104-
srcs = ["source/ray-core/_examples/doc_code/runtime_env_example.py"],
103+
main = "examples/doc_code/runtime_env_example.py",
104+
srcs = ["examples/doc_code/runtime_env_example.py"],
105105
tags = ["exclusive", "post_wheel_build", "team:serve"]
106106
)
107107

@@ -113,17 +113,17 @@ py_test(
113113
py_test(
114114
name = "tune_sklearn",
115115
size = "medium",
116-
main = "source/ray-tune/_tutorials/tune-sklearn.py",
117-
srcs = ["source/ray-tune/_tutorials/tune-sklearn.py"],
116+
main = "source/tune/_tutorials/tune-sklearn.py",
117+
srcs = ["source/tune/_tutorials/tune-sklearn.py"],
118118
tags = ["exclusive", "example", "team:ml"],
119119
args = ["--smoke-test"]
120120
)
121121

122122
py_test(
123123
name = "tune_serve_integration_mnist",
124124
size = "medium",
125-
main = "source/ray-tune/_tutorials/tune-serve-integration-mnist.py",
126-
srcs = ["source/ray-tune/_tutorials/tune-serve-integration-mnist.py"],
125+
main = "source/tune/_tutorials/tune-serve-integration-mnist.py",
126+
srcs = ["source/tune/_tutorials/tune-serve-integration-mnist.py"],
127127
tags = ["exclusive", "example", "team:ml"],
128128
args = ["--smoke-test", "--from_scratch", "--day 0"]
129129
)

doc/Makefile

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
88
BUILDDIR = _build
9-
AUTOGALLERYDIR= source/ray-core/examples \
10-
source/ray-tune/tutorials \
11-
source/ray-tune/generated_guides \
12-
source/ray-data/examples
9+
AUTOGALLERYDIR= source/auto_examples source/tune/tutorials source/tune/generated_guides source/data/examples
1310

1411
# User-friendly check for sphinx-build
1512
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -57,7 +54,7 @@ clean:
5754
rm -rf site/_site site/Gemfile.lock site/.sass-cache
5855

5956
html:
60-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
57+
$(SPHINXBUILD) -W -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
6158
@echo
6259
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
6360

@@ -176,7 +173,6 @@ linkcheck:
176173
@echo "Link check complete; look for any errors in the above output " \
177174
"or in $(BUILDDIR)/linkcheck/output.txt."
178175

179-
# Currently most (>98%) of doctests fail.
180176
doctest:
181177
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
182178
@echo "Testing of doctests in the sources finished, look at the " \

doc/README.md

Lines changed: 7 additions & 60 deletions

doc/source/ray-core/_examples/cython/cython_examples/__init__.py renamed to doc/examples/cython/cython_examples/__init__.py

File renamed without changes.

doc/source/ray-core/_examples/cython/cython_examples/cython_blas.pyx renamed to doc/examples/cython/cython_examples/cython_blas.pyx

File renamed without changes.

0 commit comments

Comments
 (0)