Fixing document readability issues

The default width was too small and required scrolling. Also mobile readability wasn't great.
zoltan-fedor · Oct 12, 2020 · 2611708 · 2611708
1 parent 08f3438
commit 2611708
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,6 +1,11 @@
 Changelog
 =========
 
+Version 0.1.1
+-------------
+
+- Fixing document readability issues in Sphinx
+
 Version 0.1.0
 -------------
 

diff --git a/README.md b/README.md
@@ -62,7 +62,8 @@ limiter = Limiter(
     key_func=get_access_route_addr,
     default_limits="5 per minute,2 per second",
     # only count HTTP 200 responses against the limit:
-    default_deduct_when=lambda req, resp, resource, req_succeeded: resp.status == falcon.HTTP_200,
+    default_deduct_when=lambda req, resp, resource, req_succeeded:
+        resp.status == falcon.HTTP_200,
     config={
         'RATELIMIT_KEY_PREFIX': 'myapp',  # to allow multiple apps in the same Redis db
         'RATELIMIT_STORAGE_URL': f'redis://:{REDIS_PSW}@{REDIS_HOST}:{REDIS_PORT}',

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,4 @@
+div.body {
+    min-width: auto !important;
+    max-width: none !important;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -59,11 +59,21 @@
 #
 html_theme = 'alabaster'
 
+html_theme_options = {
+    'page_width': '1140px'
+}
+
 # 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']
 
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    'custom.css'
+]
+
 
 # -- Extension configuration -------------------------------------------------
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -49,7 +49,8 @@ and running the application behind a reverse proxy:
         key_func=get_access_route_addr,
         default_limits="5 per minute,2 per second",
         # only count HTTP 200 responses against the limit:
-        default_deduct_when=lambda req, resp, resource, req_succeeded: resp.status == falcon.HTTP_200,
+        default_deduct_when=lambda req, resp, resource, req_succeeded:
+            resp.status == falcon.HTTP_200,
         config={
             'RATELIMIT_KEY_PREFIX': 'myapp',  # to allow multiple apps in the same Redis db
             'RATELIMIT_STORAGE_URL': f'redis://:{REDIS_PSW}@{REDIS_HOST}:{REDIS_PORT}',