Make it possible to view generated .html doc files with local browser

[dabrahams]

Feature Name

Browsable local files

Description

When trying to come up with a correct configuration to generate documentation in a GitHub Action, Docc is quite opaque. One thing that hurts is that I can't reproduce the command locally and validate it by looking at the files in a browser. If you could make that work, it would be easier to get this set up and working.

Motivation

No response

Importance

No response

Alternatives Considered

No response

[ethan-kusters]

Hi @dabrahams – thanks for the filing this. As a workaround – I generally use a python http server to test his kind of thing locally.

So assuming you're publishing a framework called MyFramework from a repository in a /docs directory:

swift package generate-documentation --target MyFramework --output-path /path/to/docs
cd /path/to/docs
python3 -m http.server
# open localhost:8000/documentation/MyFramework