Rework trait and weapon docs page generation

[penev92]

Initially I just wanted a flag to export the weapon docs info as JSON so that the OpenRA Language Server (oraide) can use it in certain scenarios, but after a request by @pchote on Discord I landed on the current solution of switching all exports to JSON and having a Python script to generate Markdown.

• The first commit is a straight up improvement of the current code and needs to get in no matter what.
  - After this PR is done, I'll need to do the same thing for the traits docs. (I also have the same thing lined up for sequences documentation)

There are two goals here:

• To slightly update https://docs.openra.net/en/latest/release/weapons/ (without introducing any major changes). You can see the generated Markdown (generated from the generated JSON) here: https://github.com/penev92/OpenRA/wiki/Weapon-properties-documentation.
• Same for https://docs.openra.net/en/latest/release/traits with the new Markdown showcased here: https://github.com/penev92/OpenRA/wiki/Trait-documentation-example.
• The JSON will also be used by oraide.

P.S.: The final result is now also available on a test version of the docs site:
https://docs.openra.net/en/test/dev/traits/
https://docs.openra.net/en/test/dev/weapons/

[penev92]

Fixed a couple more small nits plus the above comment.
Also updated the PR description.

[penev92]

Rebased.

[penev92]

So I reworked the Python script to be able to generate documentation Markdown files for traits and weapons (and sequences) instead of having separate scripts. I also added the trait JSON generation here.
In this latest turn of events #19986 will now depend on this and will add everything sequence-related when this is merged.

[penev92]

See, this is why we can't have nice things.

[Mailaender]

It dumps source code excerpts the average moddern can't understand, and it will overflow the already quite large width of the table.

[penev92]

The exact same thing can be said about the Type column. By the way, most of the Default Value column is empty, just taking up space and not all of the values in there are very clear either.

[Mailaender]

That one is more important for modding. Otherwise, you would be surprised by defaults. Especially since some still contain C&C actor names and stuff.

[Mailaender]

You could use

hover text for example.

or

This is another hover text example with references.

but I don't know if @readthedocs supports it.

[penev92]

After a bunch more discussion on Discord this is what I am settling on:

a "compromise" solution - don't show the extra info in the docs, "encouraging" people to get and use ORAIDE to show them the rest 😏

The "extra info" being the attribute's parameters. Now only showing attribute names.

Updated both example wiki pages (traits & weapons) to match the current state of the PR.

[PunkPun]

👍

[penev92]

The final result of all the generating and transforming can be seen here:
https://docs.openra.net/en/test/dev/traits/
https://docs.openra.net/en/test/dev/weapons/

[Mailaender]

Changelog