#109
gdtest_exclude_list
OK
CONFIG
Tests exclude config
Tests exclude config list. Module has 5 exports but 2 are excluded via config. Reference page should show only the 3 non-excluded items.
Build Mode
● Has great-docs.yml
This package ships a pre-supplied config.
The great-docs init step is skipped and
great-docs build uses the spec-defined configuration directly.
Tests specific config options and their rendered output.
Dimensions
K16
K16exclude listconfig
Source Files
gdtest_exclude_list/
__init__.py
"""Package testing exclude config."""
__version__ = "0.1.0"
__all__ = ["public_a", "public_b", "public_c", "_hidden_func", "InternalHelper"]
def public_a() -> str:
"""
Return public value A.
Returns
-------
str
The string value A.
"""
return "a"
def public_b() -> str:
"""
Return public value B.
Returns
-------
str
The string value B.
"""
return "b"
def public_c() -> str:
"""
Return public value C.
Returns
-------
str
The string value C.
"""
return "c"
def _hidden_func() -> str:
"""
A hidden function that should be excluded.
Returns
-------
str
A hidden value.
"""
return "hidden"
class InternalHelper:
"""An internal helper class that should be excluded."""
def help(self) -> str:
"""
Provide help.
Returns
-------
str
A help message.
"""
return "help"README.md
# gdtest-exclude-list Tests exclude config.
great-docs.yml
exclude: - _hidden_func - InternalHelper