Skip to content

Commit

Permalink
Add titles to methods and properties sections
Browse files Browse the repository at this point in the history
  • Loading branch information
@JessSaavedra
JessSaavedra committed Jan 14, 2025
1 parent 967ca47 commit fb49e02
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 96 deletions.
31 changes: 3 additions & 28 deletions docs/docusaurus/src/css/api_docs/api_docs.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,33 +57,8 @@
}
}

.table thead {
background-color: white;

th {
border-bottom: 2px solid #4DC0B4;
border-left: 1px solid transparent;
border-right: 1px solid transparent;
border-top: 1px solid transparent;
padding: 0.4rem;
}

p {
color: #4DC0B4;
font-size: 20px;
font-weight: 600;
}
}

.table td {
border-left: 1px solid transparent;
border-right: 1px solid transparent;
h2 {
color: var(--ifm-font-color-base);
font-weight: var(--ifm-font-weight-bold);
}

div pre {
border-top: none;
margin: 0;
padding-top: 0;
}

}
61 changes: 21 additions & 40 deletions docs/sphinx_api_docs_source/utils.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,53 +36,34 @@ def apply_markdown_adjustments(soup, html_file_path, html_file_contents): # noq
item.insert(0, "\r\n")
item.append("\r\n")

# Add h2 title to Methods section
methods = soup.select(".py.method")
if methods:
wrapper_div = soup.new_tag('div')
title_h2 = soup.new_tag('h2')
title_h2.string = "Methods"
parent = methods[0].parent

for method in methods:
wrapper_div.append(method.extract())

wrapper_div.insert(0, "\r\n")
wrapper_div.insert(1, title_h2)
wrapper_div.insert(2, "\r\n")
parent.insert_after(wrapper_div)

# Add h2 title to Properties section
properties = soup.select(".py.property")
if properties:
wrapper_div = soup.new_tag("div")
title_h2 = soup.new_tag("h2")
wrapper_div = soup.new_tag('div')
title_h2 = soup.new_tag('h2')
title_h2.string = "Properties"
parent = properties[0].parent
table = soup.new_tag("table")
body = soup.new_tag("tbody")
# head = soup.new_tag("thead")
# head_row = soup.new_tag("tr")
# head_column = soup.new_tag("th")
# head_column.append("Description")
# head_row.append(head_column)
# head.apend(head_row)
# table.append(head)

for prop in properties:
new_row = soup.new_tag("tr")
new_column = soup.new_tag("td")
new_column.append(prop.get_text())
new_row.append(new_column)
body.append(new_row)
for property in properties:
wrapper_div.append(property.extract())

wrapper_div.insert(0, "\r\n")
wrapper_div.insert(1, title_h2)
wrapper_div.insert(2, "\r\n")
table.append(body)
wrapper_div.append(table)
parent.insert_after(wrapper_div)

methods = soup.select(".py.method")
if methods:
wrapper_div_m = soup.new_tag("div")
title_h2_m = soup.new_tag("h2")
title_h2_m.string = "Methods"
parent_m = methods[0].parent

for method in methods:
wrapper_div_m.append(method.extract())
wrapper_div_m.insert(0, "\r\n")
wrapper_div_m.insert(1, title_h2_m)
wrapper_div_m.insert(2, "\r\n")
parent_m.insert_after(wrapper_div_m)

# Display signatures as code blocks
items = soup.select(".sig-object")
for item in items:
code_block = soup.new_tag("CodeBlock", language="python", title="Signature")
code_block.append("{`" + item.get_text() + "`}")
item.replace_with(code_block)
1 change: 0 additions & 1 deletion great_expectations/checkpoint/checkpoint.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ class Checkpoint(BaseModel):
Args:
name: The name of the checkpoint.
lala: jiji.
validation_definitions: List of validation definitions to be run.
actions: List of actions to be taken after the validation definitions are run.
result_format: The format in which to return the results of the validation definitions. Default is ResultFormat.SUMMARY.
Expand Down
41 changes: 14 additions & 27 deletions great_expectations/data_context/data_context/abstract_data_context.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2231,39 +2231,26 @@ def build_data_docs(
--Documentation--
- https://docs.greatexpectations.io/docs/terms/data_docs/
.. list-table:: Parameters
:widths: 18 20 10
:header-rows: 1
* - Name
- Description
- Default
* - site_names
- if specified, build data docs only for these sites, otherwise, build all the sites specified in the context's config
- Required
* - resource_identifiers
- a list of resource identifiers (ExpectationSuiteIdentifier,
ValidationResultIdentifier). If specified, rebuild HTML
(or other views the data docs sites are rendering) only for
the resources in this list. This supports incremental build
of data docs sites (e.g., when a new validation result is created)
and avoids full rebuild.
- None
* - dry_run
- a flag, if True, the method returns a structure containing the
URLs of the sites that *would* be built, but it does not build
these sites.
- None
* - build_index
- a flag if False, skips building the index page
- None
Args:
site_names: if specified, build data docs only for these sites, otherwise,
build all the sites specified in the context's config
resource_identifiers: a list of resource identifiers (ExpectationSuiteIdentifier,
ValidationResultIdentifier). If specified, rebuild HTML
(or other views the data docs sites are rendering) only for
the resources in this list. This supports incremental build
of data docs sites (e.g., when a new validation result is created)
and avoids full rebuild.
dry_run: a flag, if True, the method returns a structure containing the
URLs of the sites that *would* be built, but it does not build
these sites.
build_index: a flag if False, skips building the index page
Returns:
A dictionary with the names of the updated data documentation sites as keys and the location info
of their index.html files as values
Raises:
ClassInstantiationError: Site config in your Data Context config is not valid.
""" # noqa: E501 # FIXME CoP
return self._build_data_docs(
site_names=site_names,
Expand Down

0 comments on commit fb49e02

Please sign in to comment.