Skip to content

Introduce special markup to allow documenting array_of and object_of properties #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 28, 2024
Merged

Introduce special markup to allow documenting array_of and object_of properties #374

merged 2 commits into from
Mar 28, 2024

Conversation

Blacksmoke16
Copy link
Member

@Blacksmoke16 Blacksmoke16 commented Mar 27, 2024 •
edited
Loading

  • Fix linking to schema pages
  • Denote required configuration properties
  • Re-build entire site when templates are edited
  • Introduce special markup that can be added to an array_of or object_of property to allow documenting their child properties
    • Builds out a JSON string that is consumed within the custom mkdocs material template in order to build out the list and related information

@Blacksmoke16 Blacksmoke16 added component:dependency-injection kind:enhancement New functionality to an existing feature labels Mar 27, 2024
@Blacksmoke16 Blacksmoke16 enabled auto-merge (squash) March 28, 2024 01:11
@Blacksmoke16 Blacksmoke16 merged commit 6940e2f into master Mar 28, 2024
@Blacksmoke16 Blacksmoke16 deleted the nested-param-docs branch March 28, 2024 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
component:dependency-injection kind:enhancement New functionality to an existing feature
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Blacksmoke16