Skip to content

Commit 6311224

Browse files
ya7010ya7010
committed
docs: restructure API documentation and add new references for TPPT modules
1 parent 0cbdb5b commit 6311224

File tree

11 files changed

+132
-8
lines changed

11 files changed

+132
-8
lines changed

‎docs/docs/api.md‎ renamed to ‎docs/docs/api/tppt.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# API Reference
2-
31
::: tppt
42
options:
53
show_root_heading: true
6-
show_root_full_path: false
4+
show_root_full_path: true
75
show_category_heading: true
86
show_if_no_docstring: true
97
show_signature_annotations: true
108
show_bases: true
119
show_submodules: true
1210
group_by_category: true
1311
heading_level: 2
14-
members_order: source
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_exception.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.exception
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_pptx.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.pptx
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_pptx_dml.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.pptx.dml
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_pptx_shape.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.pptx.shape
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_pptx_text.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.pptx.text
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_template.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.template
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/api/tppt_types.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: tppt.types
2+
options:
3+
show_root_heading: true
4+
show_root_full_path: true
5+
show_category_heading: true
6+
show_if_no_docstring: true
7+
show_signature_annotations: true
8+
show_bases: true
9+
show_submodules: true
10+
group_by_category: true
11+
heading_level: 2
12+
members_order: source
13+
selection:
14+
docstring_style: google
15+
filters: ["!^_"]

‎docs/docs/examples.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Examples
22

3-
Here are some examples of how to use TPPT in various scenarios.
3+
Here are some examples of how to use TPPT in various scenarios. For detailed API reference, see [Core API Reference](api/core.md), [PPTX API Reference](api/pptx.md), [DML API Reference](api/dml.md), [Shape API Reference](api/shape.md), [Text API Reference](api/text.md), [Template API Reference](api/template.md), [Types API Reference](api/types.md), and [Exception API Reference](api/exception.md).
44

55
## Basic Presentation
66

‎docs/docs/usage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage Guide
22

3-
This guide will walk you through the basic usage of TPPT.
3+
This guide will walk you through the basic usage of TPPT. For detailed API reference, see [Core API Reference](api/core.md), [PPTX API Reference](api/pptx.md), [DML API Reference](api/dml.md), [Shape API Reference](api/shape.md), [Text API Reference](api/text.md), [Template API Reference](api/template.md), [Types API Reference](api/types.md), and [Exception API Reference](api/exception.md).
44

55
## Creating a Presentation
66

0 commit comments

Comments
 (0)