Skip to content

rework documentation build process - push hosting base path knowledge up front #162

Description

@heckj

We're doing a lot of post-processing that's a side effect of the existing docc process-archive command that applies the hosting base path (such as main, 6.4, or latest) after the various archives are merged.

Per @d-ronnqvist in the Forums (https://forums.swift.org/t/future-of-the-transform-for-static-hosting-subcommand/89304/14) - I'm mis-using that command and all of the details for hosting base paths should be known up-front when invoking the initial convert commands, and that DocC does not have a supported path for adjusting it after the fact using it's UI.

The side effect here is that content (HTML, FavIcon, etc) is getting re-rendered from the default, built-in stubs, so it's loosing content such as embedded HTML, custom values, etc - and we're working around that we post processing overrides after DocC has "done it's thing".

This means the standard library build will need to reflect the corrected hosting base path as well, and then we can work from the download and build the remaining docc archives individually with the correct values before the final step - merging them, with no trailing "transform" step.

Some post-processing is still going to be needed, but this part (at least) should get reset.

It may make sense to also have the CI build only produce a relevant collection of symbol graphs and them assemble them after the fact with the DocC converts all happening from here, in order to both simplify the logic and set this up for multi-platform builds with symbols from various platforms: Linux, Windows, macOS, iOS, etc.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

taskInternal work or maintenance task

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions