improving docs html

Author: samuelcolvin

.travis.yml

@@ -18,6 +18,7 @@ install:
 script:
 - make lint
 - make test
+- make docs
 - ./tests/check_tag.py
 
 after_success:

HISTORY.rst

@@ -7,7 +7,7 @@ v0.3.0 (2017-10-11)
 ...................
 * allow ``async/await`` arguments
 * fix subscript
-* fix weird named tuples eg ``mock > call_args``
+* fix weird named tuples eg. ``mock > call_args``
 
 v0.2.0 (2017-09-14)
 ...................

Makefile

@@ -58,5 +58,6 @@ docs:
 .PHONY: publish
 publish: docs
 	cd docs/_build/ && cp -r html site && zip -r site.zip site
-	@curl -H "Content-Type: application/zip" -H "Authorization: Bearer ${NETLIFY}" \
+	@curl -i -H "Content-Type: application/zip" -H "Authorization: Bearer ${NETLIFY}" \
 	      --data-binary "@docs/_build/site.zip" https://api.netlify.com/api/v1/sites/python-devtools.netlify.com/deploys
+	@echo " "

devtools/debug.py

@@ -9,20 +9,12 @@
 from typing import Generator, List, Optional, Tuple, Type
 
 from .ansi import isatty, sformat
-from .prettier import PrettyFormat
+from .prettier import PrettyFormat, env_true
 
 __all__ = ['Debug', 'debug']
 CWD = Path('.').resolve()
 
 
-def env_true(var_name, alt=None):
-    env = os.getenv(var_name, None)
-    if env:
-        return env.upper() in {'1', 'TRUE'}
-    else:
-        return alt
-
-
 pformat = PrettyFormat(
     indent_step=int(os.getenv('PY_DEVTOOLS_INDENT', 4)),
     simple_cutoff=int(os.getenv('PY_DEVTOOLS_SIMPLE_CUTOFF', 10)),

devtools/prettier.py

@@ -1,5 +1,6 @@
 import collections
 import io
+import os
 import textwrap
 from typing import Any, Generator, Union
 
@@ -22,6 +23,14 @@
 __all__ = ['PrettyFormat', 'pformat', 'pprint']
 
 
+def env_true(var_name, alt=None):
+    env = os.getenv(var_name, None)
+    if env:
+        return env.upper() in {'1', 'TRUE'}
+    else:
+        return alt
+
+
 class PrettyFormat:
     def __init__(self,
                  indent_step=4,
@@ -168,7 +177,9 @@ def _format_raw(self, value: Any, value_repr: str, indent_current: int, indent_n
 
 
 pformat = PrettyFormat()
+force_highlight = env_true('PY_DEVTOOLS_HIGHLIGHT', None)
 
 
 def pprint(s, file=None):
-    print(pformat(s, highlight=isatty(file)), file=file, flush=True)
+    highlight = isatty(file) if force_highlight is None else force_highlight
+    print(pformat(s, highlight=highlight), file=file, flush=True)

docs/Makefile

@@ -15,12 +15,7 @@ clean:
 
 .PHONY: doc-examples
 doc-examples:
-	@( echo '<pre class="ansi2html-content">'; \
-	PY_DEVTOOLS_HIGHLIGHT=true python examples/1_input.py | ansi2html -p; \
-	echo '</pre>' ) > examples/1_output.html
-	@( echo '<pre class="ansi2html-content">'; \
-	PY_DEVTOOLS_HIGHLIGHT=true python examples/2_input.py | ansi2html -p; \
-	echo '</pre>' ) > examples/2_output.html
+	./gen_html.py
 
 .PHONY: html
 html: clean doc-examples

docs/_templates/layout.html

@@ -2,12 +2,18 @@
 
 {% block extrahead %}
 <style>
+  .divider {
+    text-align: center;
+    font-weight: bold;
+    margin: -12px;
+  }
   .ansi2html-content {
     white-space: pre-wrap;
     word-wrap: break-word;
     line-height: normal;
     background-color: #300a24;
     padding: 20px 30px;
+    color: white;
   }
   .body_foreground { color: #AAAAAA; }
   .body_background { background-color: #000000; }

docs/examples/1_input.py docs/examples/ex1.pydocs/examples/1_input.py renamed to docs/examples/ex1.py

@@ -6,28 +6,12 @@
     'generator': (i * 2 for i in [1, 2, 3]),
 }
 
+# pretty print of v
 pprint(v)
-# > with colours:
-"""
-{
-    'foo': {
-        'whatever': [3, 2, 1],
-    },
-    'sentence': (
-        'hello\n'
-        'world'
-    ),
-    'generator': (
-        2,
-        4,
-        6,
-    ),
-}
-"""
 
+# as above without colours, the generator will also be empty as it's already been evaluated
 s = pformat(v, highlight=False)
 print(s)
-# > as above without colours, the generator will also be empty as it's already been evaluated
 
 pp = PrettyFormat(
      indent_step=2,  # default: 4
@@ -38,18 +22,4 @@
      yield_from_generators=False  # default: True (whether to evaluate generators)
 )
 
-print(pp(v))
-# >
-"""
-{
-__'foo': {
-____'whatever': [
-______'apple',
-______123,
-______45.67,
-____],
-__},
-__'sentence': 'hello\nworld',
-__'generator': <generator object <genexpr> at 0x7f448b7cebf8>,
-}
-"""
+print(pp(v, highlight=True))