I need to generate documentation that can be viewed in a browser and can contain cross references. RST seems to be the best option. Actually, DITA (see issue #8) would be the best, but given that's it's somewhat niche, might not be the most practical choice. So, two questions:
In the issue referenced above, a description of the intermediate representation was presented. Given RST in the doc strings how difficult would it be to 'walk' or otherwise work with the existing intermediate representation to output HTML? There is a python module rst2html that can do the conversion, so this seems like a intermediate representation manipulation problem.
If the existing intermediate representation isn't a good choice to work with, is the machinery for reading all the doc strings available? This would actually be a very useful as a stand-alone system for other documentation systems.
As a start, the second option wouldn't give us cross referencing without additional work, but it's a start.
snunez1
commented
1 year ago
I need to generate documentation that can be viewed in a browser and can contain cross references. RST seems to be the best option. Actually, DITA (see issue #8) would be the best, but given that's it's somewhat niche, might not be the most practical choice. So, two questions:
As a start, the second option wouldn't give us cross referencing without additional work, but it's a start.