docc2html icon indicating copy to clipboard operation
docc2html copied to clipboard

Add a Root Page to the Exported HTML Page

Open PSchmiedmayer opened this issue 4 years ago • 0 comments

Current Issue

docc2html currently doesn't produce an index.html file at the root of the exported folder that links to the generated HTML files documenting a target. When publishing the documentation as an HTML page, you need to generate an HTML page that links to the targets or automatically forwards to a target if only one target is present.

You can see the issue in the following GitHub Pages based deployment: https://apodini.github.io/Template-Repository/ returns a 404 error. The DocC documentation is successfully found in the subfolders of the HTML export: https://apodini.github.io/Template-Repository/documentation/apodinitemplate/apodinitemplate/index.html

Suggested Solution

It would be great if docc2html could generate an index.html page listing all targets included in the exported documentation and linking to the related index.html pages in the subfolders. If there is only one exported target, the page should automatically link to the only target present in the documentation archive.

Related Issues

The issue was first noted in issue #13

PSchmiedmayer avatar Aug 24 '21 20:08 PSchmiedmayer