search

swiftlang / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.19k stars 127 forks source link

[SR-15750] [Swift-DocC] `docc archive transform-for-static-hosting` should add support for experimental custom header/footer feature #191

Open ethan-kusters opened 2 years ago

ethan-kusters commented 2 years ago
Previous ID SR-15750
Radar rdar://problem/87740373
Original Reporter @ethan-kusters
Type Improvement
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 0 | |Component/s | Swift-DocC | |Labels | Improvement | |Assignee | None | |Priority | Medium | md5: 717260373b6916638ec4326a5b4138a8

cloned from:

relates to:

Issue Description:

Currently the `docc archive transform-for-static-hosting` action does not respect the experimental header/footer that can be provided in a DocC Catalog.

Note that this bug is specifically tracking support for transforming a pre-built archive that made use of the experimental header/footer feature. Support for picking up an experiemental header/footer as part of the initial conversion is tracked with SR-15576.

The implementation of this would add a new --experimental-enable-custom-templates flag to docc archive transform-for-static-hosting.

ethan-kusters commented 2 years ago

@swift-ci create

louwers commented 4 months ago

Could this throw at least error in the meantime?

louwers commented 4 months ago

An identical issue seems to be closed: https://github.com/apple/swift-docc/issues/196

Never mind, that is for convert. I am using process-archive transform-for-static-hosting