Provide documentation from toolshed bundles online

[Tom Goddard]

If I add a bundle to the toolshed that includes documentation for a command I'd like to be able to link to that command documentation, for instance, from a tutorial. Could we extract documentation submitted within toolshed bundles and put it online with our online daily build ChimeraX docs?

I ran into this when looking at including documentation for the "device realsense" command with the new RealSense toolshed bundle. But I need my tutorial to be able to link to the command documentation. For now I will have Elaine put the documentation in the ChimeraX distribution instead of in the bundle.

[Greg Couch]

The documentation should be extracted from the wheel and placed in a standard location. That way links can be placed to the tool and command documentation on the toolshed page. And, the vdoc code would be able to integrate it into the web version.

[Greg Couch]

The next step is for the documentation for toolshed bundles to be extracted in to a know location. The idea is to merge the documentation for the latest version of the bundles with the current documentation. It can either be done when the bundle is uploaded (if the bundle will become the newest), or daily.

Once the bundle documentation is extracted to a known location, we will update the web site daily via the daily build. The current plan is to use the chimerax-daily installation and the vdocs to prepare the version for the web.

[Greg Couch]

"ping"

[Elaine Meng]

I thought there was a ticket that included the suggestion that bundle metadata should include a field for specifying an arbitrary filename or URL for the user documentation, so that the developer is not restricted to a certain name based on various rules. However, I could not find such a ticket... which is not to say it doesn't exist. I recall Conrad saying it was a good idea when I suggested it. But maybe this ticket (which I don't fully understand) does not relate to that issue.