Skip to content

Include df-structures descriptions in docs #993

@PeridexisErrant

Description

@PeridexisErrant

It would be nice to include a readable version of the structures XML files in our documentation, for the benefit of script authors and others. Ideally we could parse them and translate to a nicely cross-linked format, but full support for that is more trouble than it's worth at this stage.

Here's an example implementation; I'll make a pull request once I do some more work (switch to stdlib XML library, and confirm Py2 support) and #972 is merged (so I can improve style without merge conflicts).

This demo version has a page per file, broken into sections with link targets (for use by eg. the Lua API docs). Each section is just pretty-printed and syntax-highlighted xml however, and I'm not planning to do more than that - improving the comments in the source files would be far more useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions