File tree Expand file tree Collapse file tree 5 files changed +97
-1
lines changed Expand file tree Collapse file tree 5 files changed +97
-1
lines changed Original file line number Diff line number Diff line change 1+ # Configuration Models - ` vcspull.config.models `
2+
3+ This page documents the Pydantic models used to configure VCSPull.
4+
5+ ## Repository Model
6+
7+ The Repository model represents a single repository configuration.
8+
9+ ``` {eval-rst}
10+ .. autopydantic_model:: vcspull.config.models.Repository
11+ :inherited-members: BaseModel
12+ :model-show-json: True
13+ :model-show-field-summary: True
14+ :field-signature-prefix: param
15+ ```
16+
17+ ## Settings Model
18+
19+ The Settings model controls global behavior of VCSPull.
20+
21+ ``` {eval-rst}
22+ .. autopydantic_model:: vcspull.config.models.Settings
23+ :inherited-members: BaseModel
24+ :model-show-json: True
25+ :model-show-field-summary: True
26+ :field-signature-prefix: param
27+ ```
28+
29+ ## VCSPullConfig Model
30+
31+ The VCSPullConfig model is the root configuration model for VCSPull.
32+
33+ ``` {eval-rst}
34+ .. autopydantic_model:: vcspull.config.models.VCSPullConfig
35+ :inherited-members: BaseModel
36+ :model-show-json: True
37+ :model-show-field-summary: True
38+ :field-signature-prefix: param
39+ ```
Original file line number Diff line number Diff line change 66For granular control see {ref}` libvcs <libvcs:index> ` 's {ref}` Commands <libvcs:cmd> ` and {ref}` Projects <libvcs:projects> ` .
77:::
88
9+ ## Configuration
10+
11+ ``` {toctree}
12+ config
13+ config_models
14+ ```
15+
916## Internals
1017
1118:::{warning}
@@ -15,7 +22,6 @@ If you need an internal API stabilized please [file an issue](https://github.com
1522:::
1623
1724``` {toctree}
18- config
1925cli/index
2026exc
2127log
Original file line number Diff line number Diff line change 4141 "sphinxext.rediraffe" ,
4242 "myst_parser" ,
4343 "linkify_issues" ,
44+ "sphinxcontrib.autodoc_pydantic" ,
4445]
4546myst_enable_extensions = [
4647 "colon_fence" ,
122123autodoc_typehints = "description" # show type hints in doc body instead of signature
123124simplify_optional_unions = True
124125
126+ # autodoc_pydantic configuration
127+ autodoc_pydantic_model_show_json = True
128+ autodoc_pydantic_model_show_config = True
129+ autodoc_pydantic_model_show_validator_members = True
130+ autodoc_pydantic_model_show_field_summary = True
131+ autodoc_pydantic_model_member_order = "bysource"
132+ autodoc_pydantic_model_hide_paramlist = False
133+ autodoc_pydantic_model_undoc_members = True
134+ autodoc_pydantic_field_list_validators = True
135+ autodoc_pydantic_field_show_constraints = True
136+ autodoc_pydantic_settings_show_json = True
137+ autodoc_pydantic_settings_show_config = True
138+
125139# sphinx.ext.napoleon
126140napoleon_google_docstring = True
127141napoleon_include_init_with_doc = True
Original file line number Diff line number Diff line change 9393:hidden:
9494
9595generation
96+ schema
9697```
9798
9899## Caveats
Original file line number Diff line number Diff line change 1+ # Configuration Schema
2+
3+ This page provides the detailed JSON Schema for the VCSPull configuration.
4+
5+ ## JSON Schema
6+
7+ The following schema is automatically generated from the VCSPull configuration models.
8+
9+ ``` {eval-rst}
10+ .. autopydantic_model:: vcspull.config.models.VCSPullConfig
11+ :model-show-json-schema: True
12+ :model-show-field-summary: True
13+ :field-signature-prefix: param
14+ ```
15+
16+ ## Repository Schema
17+
18+ Individual repository configuration schema:
19+
20+ ``` {eval-rst}
21+ .. autopydantic_model:: vcspull.config.models.Repository
22+ :model-show-json-schema: True
23+ :model-show-field-summary: True
24+ :field-signature-prefix: param
25+ ```
26+
27+ ## Settings Schema
28+
29+ Global settings configuration schema:
30+
31+ ``` {eval-rst}
32+ .. autopydantic_model:: vcspull.config.models.Settings
33+ :model-show-json-schema: True
34+ :model-show-field-summary: True
35+ :field-signature-prefix: param
36+ ```
You can’t perform that action at this time.
0 commit comments