1
1
Fork 0
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
bip-client/pydoc-markdown.yml

59 lines
4.3 KiB

loaders:
- type: python
search_path: [.]
packages:
- bip.link
# - bip.mink
# - bip.pink
# - bip.wink
# - bip.uink
- bip.sdk
# - bip.utils
# - bip.plugins.sgink
ignore_when_discovered:
- bip.link.tools
processors:
- type: google
- type: filter
do_not_filter_modules: false
skip_empty_modules: true
documented_only: true
- type: smart
- type: crossref
renderer:
type: docusaurus
sidebar_top_level_label: null
docs_base_path: docs
markdown:
encoding: utf-8
insert_header_anchors: false # If enabled, inserts anchors before Markdown headers to ensure that links to the header work. This is enabled by default.
code_headers: true # Render names in headers as code (using backticks or <code> tags, depending on html_headers). This is enabled by default.
descriptive_class_title: false # Generate descriptive class titles by adding the word "Objects" after the class name. This is enabled by default.
descriptive_module_title: false # Generate descriptive module titles by adding the word "Module" before the module name. This is enabled by default.
add_module_prefix: true # Add the module name as a prefix to class & method names. This module name is also rendered as code if code_headers is enabled. This is enabled by default.
add_method_class_prefix: false # Add the class name as a prefix to method names. This class name is also rendered as code if code_headers is enabled. This is enabled by default.
add_member_class_prefix: false # Add the class name as a prefix to member names. This is enabled by default.
add_full_prefix: false # Add the full module name as a prefix to the title of the header. This is disabled by default.
sub_prefix: false # If add_full_prefix is enabled, this will result in the prefix to be wrapped in a <sub> tag.
data_code_block: false # Render the definition of data members as a code block. This is disabled by default.
data_expression_maxlength: 100 # Max length of expressions. If this limit is exceeded, the remaining characters will be replaced with three dots. This is set to 100 by default.
classdef_code_block: true # Render the class signature as a code block. This includes the "class" keyword, the class name and its bases. This is enabled by default.
classdef_render_init_signature_if_needed: true # Render the constructor signature in the class definition code block if its __init__() member is not visible.
classdef_with_decorators: false # Render decorators before class definitions.
signature_python_help_style: false # Render classdef and function signature blocks in the Python help() style.
signature_code_block: true # Render the function signature as a code block. This includes the "def" keyword, the function name and its arguments. This is enabled by default.
signature_in_header: false # Render the function signature in the header. This is disabled by default.
signature_with_vertical_bar: false # Render the vertical bar '|' before function signature. This is enabled by default.
signature_with_def: true # Include the "def" keyword in the function signature. This is enabled by default.
signature_class_prefix: false # Render the class name in the code block for function signature. Note that this results in invalid Python syntax to be rendered. This is disabled by default.
signature_with_decorators: true # Render decorators before function definitions.
render_typehint_in_data_header: false # Render type hints for data elements in the header.
code_lang: true # Add the string "python" after the backticks for code blocks. This is enabled by default.
render_page_title: false # Render title of page at the beginning of the file.
render_toc: false # Render a table of contents at the beginning of the file.
render_toc_title: Table of Contents # The title of the "Table of Contents" header.
toc_maxdepth: 2 # The maximum depth of the table of contents. Defaults to 2.
render_module_header: true # Render module headers. This is enabled by default.
docstrings_as_blockquote: false # Render docstrings as blockquotes. This is disabled by default.
use_fixed_header_levels: false # Use a fixed header level for every kind of API object. The individual levels can be defined with header_level_by_type.
escape_html_in_docstring: false