Skip to content
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

Find/Write Custom Sphinx Domain for XML/XSD #9

Open
marsfan opened this issue Aug 15, 2020 · 0 comments
Open

Find/Write Custom Sphinx Domain for XML/XSD #9

marsfan opened this issue Aug 15, 2020 · 0 comments
Labels
backend Code and configuration for thedocumentation backend documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed schema Issue/PR is relavent to the schema files

Comments

@marsfan
Copy link
Owner

marsfan commented Aug 15, 2020

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.
@marsfan marsfan added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed backend Code and configuration for thedocumentation backend schema Issue/PR is relavent to the schema files labels Aug 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backend Code and configuration for thedocumentation backend documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed schema Issue/PR is relavent to the schema files
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marsfan