Releases: swiftlang/swift-docc
Releases · swiftlang/swift-docc
Swift 6.1.1 Release
Don't parse query items for authored documentation links (#1159) (#1161) * Don't parse query items for authored documentation links rdar://144230958 * Make the fallback implementation more robust * Elaborate on code comment about doc links not having query items.
Swift 6.1 Release
What's Changed
- Document that TechnologyRoot is optional by @d-ronnqvist in #852
- Remove API that was deprecated during the 5.9 release by @d-ronnqvist in #860
- Don't enforce unique filenames for documentation extensions by @mayaepps in #863
- Update Swift tools version to 5.9 by @d-ronnqvist in #861
- Collect external links from various symbol section types by @patshaughnessy in #855
- [Overloads] Do not automatically curate overloaded symbols, in favor of their overload group by @QuietMisdreavus in #864
- Support either language representation's relative links in documentation extension files by @d-ronnqvist in #858
- Explicitly load unaligned data in test by @d-ronnqvist in #875
- Emit language specific topic sections in the markdown representation of automatic curation by @d-ronnqvist in #856
- Fix incorrect key name in ThemeSettings spec JSON by @gwynne in #873
- Support thematic breaks by @emilyychenn in #865
- Use package access level (SE-0386) instead of SPI for FileManagerProtocol by @d-ronnqvist in #878
- Clarify documentation related to article file names, and documentation extension file names. by @patshaughnessy in #874
- Fix JSON typo by @cprecioso in #884
- Auto-Capitalize First Word by @emilyychenn in #880
- Make minor phrasing changes to table article by @d-ronnqvist in #881
- Fix to auto-capitalization PR by @emilyychenn in #888
- Ignore precise line number in unit test expectation by @patshaughnessy in #887
- Add an anchor to TaskGroupRenderSection by @d-ronnqvist in #883
- Fix inconsistent assertions with some language variant symbols by @d-ronnqvist in #894
- Enable parameter and return value validation by default by @d-ronnqvist in #882
- Fix some typos by @mrs1669 in #876
- Don't suggest bundle name as possible replacement for symbol links by @d-ronnqvist in #900
- drop uncurated symbols from the navigator index by @QuietMisdreavus in #890
- add the ability to set a subset of feature flags from Info.plist by @QuietMisdreavus in #891
- Add logic to look for overload groups when emitting warnings by @patshaughnessy in #885
- Fix a few issues with infinite recursions if the content contains cyclic curation by @d-ronnqvist in #898
- Continues searching if a non-symbol matches a symbol link by @d-ronnqvist in #901
- use unified overload data for initial overload variants by @QuietMisdreavus in #907
- Apply fallback availability logic to beta information by @sofiaromorales in #910
- Fix a doc anchor is not encoded correctly by @hironytic in #867
- drop overload groups from curation if the overloads were manually curated by @QuietMisdreavus in #913
- Mark existential with
any
to unblock compiler bug fix by @AnthonyLatsis in #899 - Add missing Apple supported platforms by @sofiaromorales in #920
- Rename
TitleStyle
toPropertyListTitleStyle
to clarify its purpose by @d-ronnqvist in #919 - Much faster navigator index creation for mixed Swift and Objective-C projects by @d-ronnqvist in #917
- Update navigator image references to the correct relative path by @d-ronnqvist in #925
- Fix bug where symbols would get the framework name show up twice in the availability badges. by @sofiaromorales in #922
- Merge alternate symbol declarations across symbol graphs by @anferbui in #933
- Merge automatically curated task groups by @anferbui in #931
- Rename non-existent 5.11 release to 6.0 in the documentation by @d-ronnqvist in #936
- Improve test hygiene in ConvertSubcommandTests by @QuietMisdreavus in #934
- Handle various out-of-bounds diagnostic ranges in default diagnostics formatter by @d-ronnqvist in #947
- Micro optimization for whitespace trimming of strings by @d-ronnqvist in #945
- Fix diagnostics in Objective-C documentation comments appearing on the wrong line by @d-ronnqvist in #949
- [external-links] Display frameworks as beta only if all platforms are beta by @anferbui in #938
- Avoid visiting symbol markup twice when there's a documentation extension file by @d-ronnqvist in #951
- Address warnings about retroactively conforming types from other modules to protocols by @d-ronnqvist in #957
- update SymbolKit to latest main by @QuietMisdreavus in #958
- Deprecate the unused AttributedCodeListing type by @d-ronnqvist in #956
- Update links for repositories moved to the swiftlang org on GitHub by @ahoppen in #965
- Adding deprecated to @available directive by @mustiikhalil in #851
- Highlight declaration differences in overloaded symbol groups by @QuietMisdreavus in #928
- Compute beta platform information for non-symbol documentation by @anferbui in #959
- Remove unused code in RenderNodeTranslator by @d-ronnqvist in #960
- Remove unused code in NavigatorTree by @d-ronnqvist in #961
- Make MacCatalyst availability information mirror iOS. by @sofiaromorales in #962
- Move contributions section earlier in the README by @d-ronnqvist in #976
- Update CONTRIBUTING.md by @kolecke in #974
- Update links for repos that have moved to the swiftlang organization so far by @d-ronnqvist in #977
- Hide parameter and return value documentation from properties. by @d-ronnqvist in #968
- Delete CODE_OF_CONDUCT.md by @parispittman in #973
- Support documenting platform specific properties and return values by @d-ronnqvist in #979
@DeprecationSummary
not having effect for some symbols by @anferbui in #982- Lower severity of source-symbol-not-found diagnostic by @d-ronnqvist in #966
- Improve the diagnostics about cyclic curation by @d-ronnqvist in #984
- Support writing links in synthesized technology root pages by @d-ronnqvist in #980
- Render 'Details' section with property list key information. by @sofiaromorales in #987
- mask out tests that are failing on Linux by @QuietMisdreavus in #996
- use SymbolKit's unified graph overload grouping by @QuietMisdreavus in #986
- Beta tag heuristic should use >= when comparing platform version information by @patshaughnessy in #994
- Available directive docs by @d-ronnqvist in #990
- Resolve external links in all language variants of parameter sections by @patshaughnessy in #995
- Update
BlockDirective
extensions by @anferbui in #983 - memoize the common fragments calculation for diffing overloads by @QuietMisdreavus in #992
- Remove un-actionable warning about not finding an external symbol by @d-ronnqvist in #1010
- Support parsing links to C++ operators with trailing anchors and disambiguation by @d-ronnqvist in #1003
- [test only] Combine many of the various SGF test helpers by @d-ronnqvist in #955
...
Swift 6.0.3 Release
What's Changed
- 🍒 Make
NavigatorIndex.Builder
ignore language variants when requested by @daniel-grumberg in #1078
Full Changelog: swift-6.0.2-RELEASE...swift-6.0.3-RELEASE
Swift 5.10.1 Release
swift-5.10.1-RELEASE [5.10] Fix problem where API Collections had no roleHeading assigned …
Swift 5.10 Release
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
andunsetenv
by @compnerd in #610 - Tests: replace
sleep
withThread.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
onfinalize(_:_:_:)
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...