diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 569a891..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,63 +0,0 @@ -site_url: https://backoff.readthedocs.io/ -site_description: Python library providing function decorators for configurable backoff and retry -site_name: backoff -repo_url: https://github.com/python-backoff/backoff -repo_name: python-backoff/backoff -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to light mode - features: - - content.code.copy - - content.code.select - - content.code.annotate - - navigation.indexes - - navigation.sections - - navigation.tabs - - navigation.top - - search.highlight - - search.share - - search.suggest -markdown_extensions: - - pymdownx.highlight - - pymdownx.superfences - - pymdownx.inlinehilite - - pymdownx.snippets: - base_path: ['.'] - - admonition -plugins: - - search - - mkdocstrings: - handlers: - python: - options: - docstring_style: google - show_root_heading: yes - show_source: yes -nav: - - Home: index.md - - Getting Started: getting-started.md - - User Guide: - - Decorators: user-guide/decorators.md - - Wait Strategies: user-guide/wait-strategies.md - - Configuration: user-guide/configuration.md - - Event Handlers: user-guide/event-handlers.md - - Logging: user-guide/logging.md - - Async Support: user-guide/async.md - - Advanced: - - Combining Decorators: advanced/combining-decorators.md - - Runtime Configuration: advanced/runtime-config.md - - Custom Strategies: advanced/custom-strategies.md - - Examples: examples.md - - API Reference: api/reference.md - - FAQ: faq.md - - Changelog: changelog.md diff --git a/zensical.toml b/zensical.toml new file mode 100644 index 0000000..793e88b --- /dev/null +++ b/zensical.toml @@ -0,0 +1,66 @@ +[project] +site_url = "https://backoff.readthedocs.io/" +site_description = "Python library providing function decorators for configurable backoff and retry" +site_name = "backoff" +repo_url = "https://github.com/python-backoff/backoff" +repo_name = "python-backoff/backoff" +nav = [ + { Home = "index.md" }, + { "Getting Started" = "getting-started.md" }, + { "User Guide" = [ + { "Decorators" = "user-guide/decorators.md" }, + { "Wait Strategies" = "user-guide/wait-strategies.md" }, + { "Configuration" = "user-guide/configuration.md" }, + { "Event Handlers" = "user-guide/event-handlers.md" }, + { "Logging" = "user-guide/logging.md" }, + { "Async Support" = "user-guide/async.md" }, + ] }, + { "Advanced" = [ + { "Combining Decorators" = "advanced/combining-decorators.md" }, + { "Runtime Configuration" = "advanced/runtime-config.md" }, + { "Custom Strategies" = "advanced/custom-strategies.md" }, + ] }, + { "Examples" = "examples.md" }, + { "API Reference" = "api/reference.md" }, + { "FAQ" = "faq.md" }, + { "Changelog" = "changelog.md" }, +] + +[project.markdown_extensions.admonition] +[project.markdown_extensions.pymdownx.highlight] +pygments_lang_class = true +[project.markdown_extensions.pymdownx.inlinehilite] +[project.markdown_extensions.pymdownx.snippets] +[project.markdown_extensions.pymdownx.superfences] + +[project.plugins.mkdocstrings.handlers.python.options] +docstring_style = "google" +inherited_members = true +show_source = true + +[project.theme] +name = "material" +features = [ + "content.code.copy", + "content.code.select", + "content.code.annotate", + "navigation.indexes", + "navigation.sections", + "navigation.tabs", + "navigation.top", + "search.highlight", + "search.share", + "search.suggest", +] + +[[project.theme.palette]] +media = "(prefers-color-scheme: light)" +scheme = "default" +toggle.icon = "material/brightness-7" +toggle.name = "Switch to dark mode" + +[[project.theme.palette]] +media = "(prefers-color-scheme: dark)" +scheme = "slate" +toggle.icon = "material/brightness-4" +toggle.name = "Switch to light mode"