Skip to content

Commit 98f77c3

Browse files
update docs wip
1 parent c20ecc5 commit 98f77c3

6 files changed

Lines changed: 1186 additions & 241 deletions

File tree

diffly/summary.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ def format(self, pretty: bool | None = None) -> str:
107107
If set to `None`, will infer from the context.
108108
"""
109109
if pretty or pretty is None:
110-
console = Console(force_terminal=pretty, width=WIDTH)
110+
console = Console(force_terminal=pretty, force_jupyter=False, width=WIDTH)
111111
with console.capture() as capture:
112112
self._print_to_console(console)
113113
summary = capture.get()
114114

115115
else:
116-
console = Console(file=io.StringIO(), width=WIDTH)
116+
console = Console(file=io.StringIO(), force_jupyter=False, width=WIDTH)
117117
self._print_to_console(console)
118118
summary = cast(io.StringIO, console.file).getvalue()
119119

docs/conf.py

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
author = "QuantCo, Inc."
3838

3939
extensions = [
40+
"myst_nb",
4041
"numpydoc",
4142
"sphinx.ext.linkcode",
4243
"sphinxcontrib.apidoc",
43-
"myst_parser",
4444
"sphinx_copybutton",
4545
]
4646

@@ -69,11 +69,6 @@
6969
# object signatures
7070
maximum_signature_line_length = 88
7171

72-
source_suffix = {
73-
".rst": "restructuredtext",
74-
".md": "markdown",
75-
}
76-
7772

7873
# Copied and adapted from
7974
# https://github.com/pandas-dev/pandas/blob/4a14d064187367cacab3ff4652a12a0e45d0711b/doc/source/conf.py#L613-L659

0 commit comments

Comments
 (0)