diff --git a/docs/conf.py b/docs/conf.py index bfa88acb..893c20d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,38 @@ # -- Options for HTML output ------------------------------------------------- -html_theme = "sphinx_rtd_theme" +html_theme = "pydata_sphinx_theme" html_static_path = ["_static"] html_css_files = ["custom.css"] + +# -- Theme configuration ----------------------------------------------------- + +html_theme_options = { + "use_edit_page_button": True, + "show_prev_next": True, + "navbar_start": ["navbar-logo"], + "secondary_sidebar_items": [ + "page-toc.html", + "searchbox.html", + "edit-this-page.html", + "sourcelink.html", + ], + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/widgetti/ipyvuetify", + "icon": "fa-brands fa-github", + }, + { + "name": "Pypi", + "url": "https://pypi.org/project/ipyvuetify/", + "icon": "fa-brands fa-python", + }, + ], +} +html_context = { + "github_user": "widgetti", + "github_repo": "ipyvuetify", + "github_version": "master", + "doc_path": "docs", +} diff --git a/docs/index.rst b/docs/index.rst index 4909eb7f..113fb406 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,31 +2,9 @@ ipyvuetify: Jupyter widgets based on Vuetify UI components ========================================================== .. toctree:: - :caption: Introduction - :maxdepth: 2 introduction - -.. toctree:: - :caption: Installation - :maxdepth: 2 - installation - -.. toctree:: - :caption: Usage - :maxdepth: 2 - usage - -.. toctree:: - :caption: Advanced usage - :maxdepth: 2 - advanced_usage - -.. toctree:: - :caption: Template usage - :maxdepth: 2 - template_usage diff --git a/pyproject.toml b/pyproject.toml index 6ced8785..6a308ef9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,7 +41,7 @@ content-type = "text/markdown" [project.optional-dependencies] dev = ["nox", "pre-commit", "mypy"] test = ["pytest", "pytest-playwright", "jupyterlab<4", "solara[pytest]"] -doc = ["sphinx<7", "jupyter-sphinx", "ipykernel"] +doc = ["sphinx<7", "jupyter-sphinx", "ipykernel", "pydata-sphinx-theme"] [tool.setuptools] include-package-data = true