[DOC]: Standardize Sphinx section and header format #234

synchon · 2023-08-04T10:42:39Z

This PR standardizes section and header ordering format for Sphinx docs.

…know/index.rst

…opics/index.rst

…val_docs.py

…ion_docs.py

…docs.py

…e_steps.rst

…ing/run_combine_pandas.py

…ing/run_grouped_cv.py

…ing/plot_cm_acc_multiclass.py

…ing/plot_example_regression.py

…ing/run_combine_pandas.py

…ction/plot_groupcv_inspect_svm.py

…ction/plot_inspect_random_forest.py

…ction/plot_preprocess.py

…ex_models/run_apply_to_target.py

…unds/run_return_confounds.py

…led/dis_run_n_jobs.py

…on.rst

codecov · 2023-08-04T10:43:29Z

Codecov Report

Merging #234 (db070ad) into main (00e8c27) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #234   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            1         1           
=========================================
  Hits             1         1

Flag	Coverage Δ
docs	`100.00% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

github-actions · 2023-08-04T10:53:15Z

PR Preview Action v1.4.4
Preview removed because the pull request was closed.
2023-09-05 12:22 UTC

…_comparison_docs.rst

synchon added 30 commits July 27, 2023 10:06

docs: standardize sphinx section header ordering in index.rst

111e288

docs: standardize sphinx section header ordering in getting_started.rst

1350827

docs: standardize sphinx section header ordering in what_really_need_…

9e5e8de

…know/index.rst

docs: standardize sphinx section header ordering in selected_deeper_t…

690cd70

…opics/index.rst

docs: standardize sphinx section header ordering in run_confound_remo…

049a973

…val_docs.py

docs: standardize sphinx section header ordering in run_model_evaluat…

924f4f8

…ion_docs.py

docs: standardize sphinx section header ordering in run_cv_splitters_…

3e313e0

…docs.py

docs: standardize sphinx section header ordering in available_pipelin…

39e722d

…e_steps.rst

docs: standardize sphinx section header ordering in examples.rst

d003b0b

docs: standardize sphinx section header ordering in examples/00_start…

b255036

…ing/run_combine_pandas.py

docs: standardize sphinx section header ordering in examples/00_start…

5567b72

…ing/run_grouped_cv.py

docs: standardize sphinx section header ordering in examples/00_start…

2aeea1b

…ing/plot_cm_acc_multiclass.py

docs: standardize sphinx section header ordering in examples/00_start…

6041210

…ing/plot_example_regression.py

docs: standardize sphinx section header ordering in examples/00_start…

4f5bf53

…ing/run_combine_pandas.py

docs: standardize sphinx section header ordering in examples/02_inspe…

e46086a

…ction/plot_groupcv_inspect_svm.py

docs: standardize sphinx section header ordering in examples/02_inspe…

38cbdcd

…ction/plot_inspect_random_forest.py

docs: standardize sphinx section header ordering in examples/02_inspe…

4d25e40

…ction/plot_preprocess.py

docs: standardize sphinx section header ordering in examples/03_compl…

4b780dd

…ex_models/run_apply_to_target.py

docs: standardize sphinx section header ordering in examples/04_confo…

1e44def

…unds/run_return_confounds.py

docs: standardize sphinx section header ordering in examples/XX_disab…

619f5d6

…led/dis_run_n_jobs.py

docs: standardize sphinx section header ordering in api/index.rst

1bdc725

docs: standardize sphinx section header ordering in api/main.rst

9ab51d5

docs: standardize sphinx section header ordering in api/pipeline.rst

9f42f9f

docs: standardize sphinx section header ordering in api/model_selecti…

884f562

…on.rst

docs: standardize sphinx section header ordering in api/base.rst

42c4f23

docs: standardize sphinx section header ordering in api/inspect.rst

911b580

docs: standardize sphinx section header ordering in api/models.rst

e72637d

docs: standardize sphinx section header ordering in api/scoring.rst

ffe3d32

docs: standardize sphinx section header ordering in api/transformers.rst

abf1c50

docs: standardize sphinx section header ordering in api/utils.rst

ca70237

synchon added 5 commits August 4, 2023 12:14

docs: standardize sphinx section header ordering in api/prepare.rst

ea64e8f

docs: standardize sphinx section header ordering in api/stats.rst

31627e6

docs: standardize sphinx section header ordering in api/viz.rst

7ddff3c

docs: standardize sphinx section header ordering in faq.rst

ce7a4fb

docs: standardize sphinx section header ordering in examples/README.rst

602a5d3

synchon added the documentation Improvements or additions to documentation label Aug 4, 2023

synchon requested a review from fraimondo August 4, 2023 10:54

synchon added 2 commits August 9, 2023 14:58

docs: standardize sphinx section header ordering in 99_docs/run_model…

1a1dc15

…_comparison_docs.rst

chore: add changelog 234.doc

db070ad

fraimondo approved these changes Sep 5, 2023

View reviewed changes

synchon merged commit 74b8600 into main Sep 5, 2023
16 checks passed

synchon deleted the docs/consistent-sphinx-structure branch September 5, 2023 12:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC]: Standardize Sphinx section and header format #234

[DOC]: Standardize Sphinx section and header format #234

synchon commented Aug 4, 2023

codecov bot commented Aug 4, 2023 •

edited

github-actions bot commented Aug 4, 2023 •

edited

[DOC]: Standardize Sphinx section and header format #234

[DOC]: Standardize Sphinx section and header format #234

Conversation

synchon commented Aug 4, 2023

codecov bot commented Aug 4, 2023 • edited

Codecov Report

github-actions bot commented Aug 4, 2023 • edited

codecov bot commented Aug 4, 2023 •

edited

github-actions bot commented Aug 4, 2023 •

edited