From ec6b7dc63d9971b54c0e39957cab591b7f276b56 Mon Sep 17 00:00:00 2001 From: Zhihui Xia Date: Thu, 13 Oct 2022 17:35:55 -0700 Subject: [PATCH 1/3] update doc style to wrap long text --- docsrc/_static/css/custom.css | 5 +++++ docsrc/conf.py | 8 ++++++++ 2 files changed, 13 insertions(+) create mode 100644 docsrc/_static/css/custom.css diff --git a/docsrc/_static/css/custom.css b/docsrc/_static/css/custom.css new file mode 100644 index 00000000..98c9f1f4 --- /dev/null +++ b/docsrc/_static/css/custom.css @@ -0,0 +1,5 @@ +@import "../bizstyle.css"; + +span.pre { + white-space: pre-wrap !important; +} \ No newline at end of file diff --git a/docsrc/conf.py b/docsrc/conf.py index 02400360..179cdfd2 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -50,6 +50,8 @@ 'awscrt': ('https://awslabs.github.io/aws-crt-python', None), } +toc_object_entries_show_parents = 'hide' + # -- Options for HTML output ------------------------------------------------- autoclass_content = "both" @@ -66,11 +68,17 @@ # html_theme = 'bizstyle' +html_theme_options = { + 'sidebarwidth': 300 +} + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_style = 'css/custom.css' + # Extra warnings nitpicky = True nitpick_ignore_regex = [ From af363066fcd20906d1d8c66af043b69047e2e5c9 Mon Sep 17 00:00:00 2001 From: Zhihui Xia Date: Fri, 14 Oct 2022 12:56:31 -0700 Subject: [PATCH 2/3] EOF --- docsrc/_static/css/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docsrc/_static/css/custom.css b/docsrc/_static/css/custom.css index 98c9f1f4..5bb62183 100644 --- a/docsrc/_static/css/custom.css +++ b/docsrc/_static/css/custom.css @@ -2,4 +2,4 @@ span.pre { white-space: pre-wrap !important; -} \ No newline at end of file +} From 7633dec91d79ac46be61200f8cff16cc0dbdc280 Mon Sep 17 00:00:00 2001 From: Zhihui Xia Date: Fri, 14 Oct 2022 13:00:56 -0700 Subject: [PATCH 3/3] add comments --- docsrc/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docsrc/conf.py b/docsrc/conf.py index 179cdfd2..f0598b25 100644 --- a/docsrc/conf.py +++ b/docsrc/conf.py @@ -50,6 +50,8 @@ 'awscrt': ('https://awslabs.github.io/aws-crt-python', None), } +# A string that determines how domain objects (e.g. functions, classes, +# attributes, etc.) are displayed in their table of contents entry. toc_object_entries_show_parents = 'hide' # -- Options for HTML output -------------------------------------------------