Skip to content

Releases: apple/swift-docc

Swift 5.10.1 Release

06 Jun 19:05
baff176
Compare
Choose a tag to compare
[5.10] Fix problem where API Collections had no roleHeading assigned …

…(#795)

rdar://90789460

The eyebrow title for articles curating a list of symbols should display 'API Collection'. Prior to this fix, the eyebrow did not show anything.

'API Collection' now appears whenever one of the curated items in the Topics section is a symbol. If the entire list does not contain a symbol (i.e., it's a plain collection), we maintain the old behavior of not displaying anything as the eyebrow title.

Tests have been added to verify the correct assignment of an eyebrow title for the following cases: Articles, API Collections, and Collections.

Renamed `contentCompiler` to `topicSectionContentCompiler` in the `visitArticle` method.

Swift 5.10 Release

06 Mar 16:07
baff176
Compare
Choose a tag to compare

What's Changed

  • Use a custom scheme for local "Declared In" source file URLs by @d-ronnqvist in #513
  • enable Doxygen support by default by @QuietMisdreavus in #519
  • Add support for multipart HTTP request bodies by @pdwilson12 in #514
  • Fix rare crash when tutorial file has same as documentation bundle identifier by @d-ronnqvist in #517
  • Add request argument to opt-out of source file path information by @d-ronnqvist in #526
  • Process typeDetails information from symbol graphs. by @pdwilson12 in #529
  • Update DocC setup instructions by @franklinsch in #511
  • Fix a crash when a protocol with a default implementation is aliased with the same name by @d-ronnqvist in #534
  • Add authoring support for a @PageColor directive by @ethan-kusters in #525
  • Disfavor default implementations and synthesized symbols in link collisions by @d-ronnqvist in #540
  • Store only the resolved reference in DocumentationContext.symbolIndex by @d-ronnqvist in #543
  • Fix rendering issue for links with special characters by @d-ronnqvist in #532
  • Fix inverse logic in hierarchy based link resolver environment opt-out by @d-ronnqvist in #548
  • [ConvertService] Support resolving images referenced in content by @d-ronnqvist in #539
  • Fix test that took seconds to type check by @d-ronnqvist in #547
  • Correctly set page color metadata for symbol pages by @ethan-kusters in #549
  • drop an "Extended Symbol" page when its children are curated elsewhere by @QuietMisdreavus in #541
  • Remove deprecated usages of 'layout' API of 'ContentAndMedia' in docs by @Saafo in #531
  • Render extended symbol pages with their extended module by @QuietMisdreavus in #557
  • Label Sample-Code Call-to-Action buttons with "View Source" by @ethan-kusters in #566
  • Match documentation extensions to symbols using link resolver by @d-ronnqvist in #565
  • Provide ConvertService with mapping of USRs to minimal access level required for extended documentation to be available by @daniel-grumberg in #555
  • Revert support for module-relative documentation extension links by @d-ronnqvist in #574
  • Expand documentation for new layout directives by @daniel-grumberg in #576
  • Support resolving code file references in ConvertService by @d-ronnqvist in #570
  • Better support for relative links when multiple symbols in the hierarchy have the same name by @d-ronnqvist in #578
  • Add successfully resolved external references to reference index by @d-ronnqvist in #582
  • Support building this repo for more platforms, by checking the build triple by @finagolfin in #500
  • Prefer non-symbols in general documentation links by @d-ronnqvist in #594
  • LMDB: introduce a typealias for mode_t by @compnerd in #600
  • Benchmark: implement memory query for Windows by @compnerd in #598
  • build: fix dependencies by @compnerd in #599
  • FoundationExtensions: enable autoreleasepool on Windows by @compnerd in #602
  • Model: enable concurrent rendering on Windows by @compnerd in #601
  • Utility: add a Windows path to the synchronisation support by @compnerd in #603
  • build: remove the PreviewServer on Windows by @compnerd in #604
  • Update distribution documentation static environment enhancements by @d-ronnqvist in #587
  • Various small documentation phrasing updates by @d-ronnqvist in #590
  • Update content formatting documentation with symbol link enhancements by @d-ronnqvist in #588
  • Utility: disable DirectoryMonitor on Windows temporarily by @compnerd in #606
  • Utility: disable Signal on Windows by @compnerd in #605
  • build: bump swift-docc-plugin to 1.2.0 for Windows by @compnerd in #607
  • build: split the SwiftDocCUtilitiesTest for Windows by @compnerd in #608
  • docc: indicate Windows as being supported by @compnerd in #609
  • Fix preview issue on macOS and Linux by @Kyle-Ye in #613
  • Fix Package.resolved syncing issue with Package.swift by @Kyle-Ye in #612
  • Remove #if os check on Package.swift file by @Kyle-Ye in #614
  • Tests: adjust synchronization tests for Windows by @compnerd in #615
  • Fix a crash when linking to a symbol that doesn't have a page by @d-ronnqvist in #617
  • Tests: use XCTUnwrap over forced unwrappng by @compnerd in #619
  • Tests: treat Windows as Linux by @compnerd in #620
  • SwiftDocCUtilitiesTests: add wrappers for setenv and unsetenv by @compnerd in #610
  • Tests: replace sleep with Thread.sleep(forTimeInterval:) by @compnerd in #616
  • keep the original URL when decoding Download/ExternalLocationReference by @QuietMisdreavus in #621
  • Add authoring support for @TitleHeading directive by @emilyychenn in #611
  • Converter: allow converting a directory w/o .docc extension by @MaxDesiatov in #585
  • Make ExternalLocationReference url property public and mutable by @ethan-kusters in #627
  • Tests: add a missed case of Windows exclusion by @compnerd in #629
  • @PageKind sets the kind for the documentation node by @QuietMisdreavus in #626
  • Tests: adjust LMDB test harness for Windows by @compnerd in #631
  • don't crash on an extension with an empty declaration by @QuietMisdreavus in #635
  • Tests: disable the LogHandle tests on Windows by @compnerd in #634
  • Finalize the diagnostic engine if an error is thrown by @d-ronnqvist in #637
  • deprecate ExternalLocationReference in favor of DownloadReference by @QuietMisdreavus in #638
  • False positive warning when curating symbol with special character by @d-ronnqvist in #642
  • Navigator: close the LMDB.Environment on finalize(_:_:_:) by @compnerd in #646
  • Make visitLineBreak return new line instead of space by @Kyle-Ye in #633
  • Allow certain directives by @emilyychenn in #641
  • Allow anchor doc:#heading within same article by @natikgadzhi in #652
  • Indexing: add a workaround for clearing the index by @compnerd in #647
  • Remove the cache based link resolver by @d-ronnqvist in #624
  • Fix typo assesment -> assessment by @stzn in #445
  • SwiftDocCUtilitiesTests: adjust TestFileSystem's handling of paths by @compnerd in #655
  • Document using DOCC_EXEC in SwiftPM by @natikgadzhi in #653
  • encode an explicit null for DownloadReference's checksum by @QuietMisdreavus in #656
  • Add i18n feature flag to ThemeSettings schema by @marinaaisa in #475
  • Improve default diagnostic formatter by @arthurcro in #535
  • Create file URLs for bundle files in TestFileSystem by @d-ronnqvist in #661
  • only use the last file component when deciding decoding strategy by @QuietMisdreavus in #665
  • Miscellaneous test changes to avoid making assumptions about what's a valid URL by @d-ronnqvist in #586
  • Tests: enable the non-Darwin behaviour on Windows by @compnerd in #671
  • Tests: standardize both sides of the URL by @compnerd in #670
  • Fix regress...
Read more