From 751c74e7de1c78a151fdd8b76f220d8411a2108a Mon Sep 17 00:00:00 2001 From: Simeon Simeonov Date: Tue, 28 Apr 2026 14:27:05 +0200 Subject: Restructure the entire project, enforce linting and add support for type checkers --- sphinx_conf.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'sphinx_conf.py') diff --git a/sphinx_conf.py b/sphinx_conf.py index 3bef39e..0e2d594 100644 --- a/sphinx_conf.py +++ b/sphinx_conf.py @@ -1,3 +1,4 @@ +"""pyotp2289 sphinx configuration""" # Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: @@ -7,20 +8,16 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'pyotp2289' -copyright = '2020-2023, Simeon Simeonov' +copyright = '2020-2026, Simeon Simeonov' # noqa: A001 author = 'Simeon Simeonov' -version = '1.2.1' -release = '1.2.1' +version = '2.0.0' +release = '2.0.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.todo', -] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.todo'] templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] @@ -32,8 +29,12 @@ language = 'en' html_theme = 'nature' html_static_path = ['_static'] +html_sidebars = {'**': ['globaltoc.html', 'searchbox.html']} # -- Options for todo extension ---------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration todo_include_todos = True + +# Generated by running: sphinx-apidoc with: +# -P -F -o html -H pyotp2289 -A "Simeon Simeonov" -V "2.0.0" src/otp2289 -- cgit v1.3