Skip to content

Update doc style to wrap long text #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2022
Merged

Update doc style to wrap long text #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec6b7dc
update doc style to wrap long text
xiazhvera Oct 14, 2022
af36306
EOF
xiazhvera Oct 14, 2022
7633dec
add comments
xiazhvera Oct 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docsrc/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
@import "../bizstyle.css";

span.pre {
white-space: pre-wrap !important;
}
10 changes: 10 additions & 0 deletions docsrc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@
'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 -------------------------------------------------

autoclass_content = "both"
Expand All @@ -66,11 +70,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 = [
Expand Down