diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css index 7cf24a748b0a..ffbeb5e47f77 100644 --- a/doc/_static/mpl.css +++ b/doc/_static/mpl.css @@ -99,3 +99,39 @@ table.property-table td { display: inline-block; margin: 0 0.5em; } +/* Removes title from toc in dropdwon */ + +.sd-dropdown>.sd-card-body>.toctree-wrapper>ul>.toctree-l1>a{ + display: none +} + +.sd-dropdown>.sd-card-body>.toctree-wrapper>ul>.toctree-l1>ul{ + list-style:none; + padding-inline-start:0em; +} + +/* styles dropdown like toctree-toggle */ +details.sd-dropdown{ + box-shadow: none !important; +} + +details.sd-dropdown summary.sd-card-header, +details.sd-dropdown summary.sd-card-header+div.sd-summary-content { + --pst-sd-dropdown-color: none; +} + +details.sd-dropdown summary { + /* padding: 1em; */ + padding: 0; +} + +.sd-dropdown>.sd-card-body{ + padding: 0; +} + +details.sd-sphinx-override.sd-dropdown.sd-card.sd-mb-3{ + border-top-style: solid !important; + border-top-color: var(--pst-color-border) !important; + border-top-width: .1em !important; + border-radius: 0; +} diff --git a/doc/users/explain/index.rst b/doc/users/explain/index.rst index c2121667da4b..e094f6050ca4 100644 --- a/doc/users/explain/index.rst +++ b/doc/users/explain/index.rst @@ -2,8 +2,9 @@ .. redirect-from:: /users/explain -Explanations ------------- + +API Documentation +================= .. toctree:: :maxdepth: 2 diff --git a/doc/users/index.rst b/doc/users/index.rst index 0ecff14c9a23..c6354ec06635 100644 --- a/doc/users/index.rst +++ b/doc/users/index.rst @@ -2,40 +2,135 @@ .. redirect-from:: /contents +========== +User guide +========== -########### -Users guide -########### +.. grid:: 1 1 3 3 -General -####### + .. grid-item-card:: Information + :shadow: none + :class-card: sd-border-0 + :class-title: sd-fs-4 -.. toctree:: - :maxdepth: 2 + .. dropdown:: :doc:`getting_started/index` + :open: + :class-title: sd-fs-5 - getting_started/index.rst - installing/index.rst - explain/index.rst - faq/index.rst - resources/index.rst + .. toctree:: + :maxdepth: 2 -Tutorials and examples -###################### + getting_started/index.rst -.. toctree:: - :maxdepth: 1 + .. dropdown:: :doc:`installing/index` + :open: + :class-title: sd-fs-5 - ../plot_types/index.rst - ../tutorials/index.rst - ../gallery/index.rst + .. toctree:: + :maxdepth: 2 -Reference -######### + installing/index.rst -.. toctree:: - :maxdepth: 2 + .. dropdown:: :doc:`../devel/index` + :open: + :class-title: sd-fs-5 - ../api/index.rst - ../devel/index.rst - project/index.rst - release_notes.rst + .. toctree:: + :maxdepth: 2 + + ../devel/index.rst + + .. dropdown:: :doc:`project/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + project/index.rst + + + .. grid-item-card:: Explanations & Examples + :shadow: none + :class-card: sd-border-0 + :class-title: sd-fs-4 + + .. dropdown:: :doc:`explain/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + explain/index.rst + + .. dropdown:: :doc:`../plot_types/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + ../plot_types/index.rst + + .. dropdown:: :doc:`../tutorials/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + ../tutorials/index.rst + + .. dropdown:: :doc:`../gallery/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + ../gallery/index.rst + + + .. grid-item-card:: References & Resources + :shadow: none + :class-card: sd-border-0 + :class-title: sd-fs-4 + + .. dropdown:: :doc:`../api/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + ../api/index.rst + + .. dropdown:: :doc:`release_notes` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + release_notes.rst + + .. dropdown:: :doc:`faq/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + faq/index.rst + + .. dropdown:: :doc:`resources/index` + :open: + :class-title: sd-fs-5 + + .. toctree:: + :maxdepth: 2 + + resources/index.rst + + `User Contributed Packages `_ diff --git a/doc/users/project/index.rst b/doc/users/project/index.rst index 27f60d166abb..f187ce45284c 100644 --- a/doc/users/project/index.rst +++ b/doc/users/project/index.rst @@ -1,7 +1,8 @@ .. redirect-from:: /users/backmatter +=================== Project information -------------------- +=================== .. toctree:: :maxdepth: 2