Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion gapic/ads-templates/docs/conf.py.j2
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{% extends '_base.py.j2' %}

{% block content %}
{% from "docs/common_setup.py.j2" import sphinx_imports, sphinx_setup %}

#
# {{ api.naming.warehouse_package_name }} documentation build configuration file
Expand All @@ -14,9 +15,11 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import logging
import os
import shlex
import sys
{{ sphinx_imports() }}

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -361,4 +364,7 @@ napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

# Setup for sphinx behaviors such as warning filters.
{{ sphinx_setup() }}
{% endblock %}
35 changes: 35 additions & 0 deletions gapic/templates/docs/common_setup.py.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{% macro sphinx_imports() -%}
import logging
from typing import Any
{%- endmacro %}

{% macro sphinx_setup() -%}
class UnexpectedUnindentFilter(logging.Filter):
"""Filter out warnings about unexpected unindentation following bullet lists."""

def filter(self, record: logging.LogRecord) -> bool:
"""Filter the log record.

Args:
record (logging.LogRecord): The log record.

Returns:
bool: False to suppress the warning, True to allow it.
"""
msg = record.getMessage()
if "Bullet list ends without a blank line" in msg:
return False
return True


def setup(app: Any) -> None:
"""Setup the Sphinx application.

Args:
app (Any): The Sphinx application.
"""
# Sphinx's logger is hierarchical. Adding a filter to the
# root 'sphinx' logger will catch warnings from all sub-loggers.
logger = logging.getLogger('sphinx')
logger.addFilter(UnexpectedUnindentFilter())
{%- endmacro %}
9 changes: 7 additions & 2 deletions gapic/templates/docs/conf.py.j2
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% extends '_base.py.j2' %}

{% block content %}

{% from "docs/common_setup.py.j2" import sphinx_imports, sphinx_setup %}
#
# {{ api.naming.warehouse_package_name }} documentation build configuration file
#
Expand All @@ -14,9 +14,11 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import logging
import os
import shlex
import sys
{{ sphinx_imports() }}

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -372,4 +374,7 @@ napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

# Setup for sphinx behaviors such as warning filters.
{{ sphinx_setup() }}
{% endblock %}
Loading