Skip to content

Commit f63499c

Browse files
docs: added auto docs
1 parent a02c3bd commit f63499c

16 files changed

Lines changed: 1181 additions & 26 deletions
Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1-
!!! note
2-
This section has not yet been written. Coming soon.
1+
2+
::: src.dve.core_engine.backends.base.auditing.BaseAuditingManager
3+
options:
4+
heading_level: 3
5+
members:
6+
- get_submission_info
7+
- get_submission_statistics
8+
- get_submission_status
9+
- get_all_file_transformation_submissions
10+
- get_all_data_contract_submissions
11+
- get_all_business_rule_submissions
12+
- get_all_error_report_submissions
13+
- get_current_processing_info
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
::: dve.metadata_parser.domain_types
3+
handler: python
4+
options:
5+
show_root_heading: true
6+
heading_level: 2
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
::: dve.core_engine.message.FeedbackMessage
3+
handler: python
4+
options:
5+
show_root_heading: true
6+
heading_level: 2
7+
8+
::: dve.core_engine.message.UserMessage
9+
handler: python
10+
options:
11+
show_root_heading: true
12+
heading_level: 2
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
::: dve.core_engine.backends.metadata.rules
3+
handler: python
4+
options:
5+
show_root_heading: true
6+
heading_level: 2
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
::: dve.core_engine.backends.base.reference_data.ReferenceTable
3+
handler: python
4+
options:
5+
show_root_heading: true
6+
heading_level: 2
7+
8+
::: dve.core_engine.backends.base.reference_data.ReferenceFile
9+
handler: python
10+
options:
11+
show_root_heading: true
12+
heading_level: 2
13+
14+
::: dve.core_engine.backends.base.reference_data.ReferenceURI
15+
handler: python
16+
options:
17+
show_root_heading: true
18+
heading_level: 2
36.4 KB
Loading
35.8 KB
Loading
47.1 KB
Loading

docs/user_guidance/auditing.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,4 @@ Currently, these are the audit tables that can be accessed within the DVE:
1818

1919
You can use the the following methods to help you interact with the tables above or you can query the table via `sql`.
2020

21-
<hr>
22-
23-
::: src.dve.core_engine.backends.base.auditing.BaseAuditingManager
24-
options:
25-
heading_level: 3
26-
members:
27-
- get_submission_info
28-
- get_submission_statistics
29-
- get_submission_status
30-
- get_all_file_transformation_submissions
31-
- get_all_data_contract_submissions
32-
- get_all_business_rule_submissions
33-
- get_all_error_report_submissions
34-
- get_current_processing_info
21+
You can read more about how to interact with the Audit Objects [here](../advanced_guidance/package_documentation/auditing.md).

0 commit comments

Comments
 (0)