-
Notifications
You must be signed in to change notification settings - Fork 3
Find/Write Custom Sphinx Domain for XML/XSD #9
Copy link
Copy link
Open
Labels
backendCode and configuration for thedocumentation backendCode and configuration for thedocumentation backenddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededschemaIssue/PR is relavent to the schema filesIssue/PR is relavent to the schema files
Description
Metadata
Metadata
Assignees
Labels
backendCode and configuration for thedocumentation backendCode and configuration for thedocumentation backenddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededschemaIssue/PR is relavent to the schema filesIssue/PR is relavent to the schema files
We should find or write a custom Sphinx domain should be implemented for documenting XSD files.
Furthermore, it would be ideal if the domain supported an automatic documentation system using the xs:annotation, xs:documentation, and xs:appinfo elements that XSD has.
If we are going to write our own custom domain, it should be done in a different repository, as it would be beneficial for other projects as well.