Skip to content

Commit

Permalink
Revise documentation table of contents (#3157)
Browse files Browse the repository at this point in the history
* Move project setup to advanced section

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Update index.rst 🤦‍♀️

---------

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
  • Loading branch information
stichbury authored Oct 12, 2023
1 parent cd83bad commit 61472ab
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 68 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/merge-gatekeeper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
timeout: 3600
interval: 30
ignored: 'runner / vale,ci/circleci: win_e2e_tests-3.7,ci/circleci: win_pip_compile-3.9,ci/circleci: win_e2e_tests-3.9,ci/circleci: win_pip_compile-3.8,ci/circleci: lint-3.7,ci/circleci: win_pip_compile-3.7,ci/circleci: pip_compile-3.7,ci/circleci: e2e_tests-3.7,ci/circleci: win_unit_tests-3.7,ci/circleci: win_unit_tests-3.9,ci/circleci: e2e_tests-3.8,ci/circleci: win_unit_tests-3.10,ci/circleci: win_pip_compile-3.10,ci/circleci: win_unit_tests-3.8,ci/circleci: e2e_tests-3.9,ci/circleci: unit_tests-3.10,ci/circleci: unit_tests-3.8,ci/circleci: e2e_tests-3.10,ci/circleci: lint-3.8,ci/circleci: unit_tests-3.9,ci/circleci: unit_tests-3.7,ci/circleci: win_e2e_tests-3.10,ci/circleci: pip_compile-3.8,ci/circleci: pip_compile-3.10,ci/circleci: win_e2e_tests-3.8,ci/circleci: lint-3.9,ci/circleci: pip_compile-3.9,ci/circleci: lint-3.10,build_code,ci/circleci: check-updated-files,regular'
ignored: 'lint_only, runner / vale,ci/circleci: win_e2e_tests-3.7,ci/circleci: win_pip_compile-3.9,ci/circleci: win_e2e_tests-3.9,ci/circleci: win_pip_compile-3.8,ci/circleci: lint-3.7,ci/circleci: win_pip_compile-3.7,ci/circleci: pip_compile-3.7,ci/circleci: e2e_tests-3.7,ci/circleci: win_unit_tests-3.7,ci/circleci: win_unit_tests-3.9,ci/circleci: e2e_tests-3.8,ci/circleci: win_unit_tests-3.10,ci/circleci: win_pip_compile-3.10,ci/circleci: win_unit_tests-3.8,ci/circleci: e2e_tests-3.9,ci/circleci: unit_tests-3.10,ci/circleci: unit_tests-3.8,ci/circleci: e2e_tests-3.10,ci/circleci: lint-3.8,ci/circleci: unit_tests-3.9,ci/circleci: unit_tests-3.7,ci/circleci: win_e2e_tests-3.10,ci/circleci: pip_compile-3.8,ci/circleci: pip_compile-3.10,ci/circleci: win_e2e_tests-3.8,ci/circleci: lint-3.9,ci/circleci: pip_compile-3.9,ci/circleci: lint-3.10,build_code,ci/circleci: check-updated-files,regular'
11 changes: 5 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,6 @@ Welcome to Kedro's documentation!
:maxdepth: 2
:caption: Kedro projects

kedro_project_setup/index.md

.. toctree::
:maxdepth: 2

configuration/index.md

.. toctree::
Expand All @@ -113,14 +108,18 @@ Welcome to Kedro's documentation!
:maxdepth: 2
:caption: Advanced usage

kedro_project_setup/index.md

.. toctree::
:maxdepth: 2

extend_kedro/index.md

.. toctree::
:maxdepth: 2

hooks/index.md


.. toctree::
:maxdepth: 2

Expand Down
2 changes: 1 addition & 1 deletion docs/source/kedro_project_setup/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kedro project setup
# Project setup

```{toctree}
:maxdepth: 1
Expand Down
Loading

0 comments on commit 61472ab

Please sign in to comment.