Make docs/README.md compatible with Swift DocC
#67893
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaxDesiatov
requested review from
ahoppen,
franklinsch,
hborla,
AnthonyLatsis,
xedin and
egorzhdan
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
from
e90833a to
1de261b
Compare
xedin
approved these changes
Aug 24, 2023
|
@swift-ci smoke test |
|
Will we provide an online version later after this PR? |
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
2 times, most recently
from
a5cb7cd to
775edd6
Compare
|
@swift-ci smoke test |
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
2 times, most recently
from
69b0529 to
41b0e88
Compare
|
@swift-ci test |
|
@swift-ci smoke test macos |
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
from
41b0e88 to
174b23f
Compare
|
@swift-ci smoke test macos |
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
from
174b23f to
e2c2397
Compare
|
@swift-ci smoke test macos |
This adds necessary metadata and updates links to Markdown documents in `README.md`. Remaining `.rst` documents still need to be converted to Markdown for linking to work.
Looks like older DocC versions require `Info.plist` to be present, especially in directories with `.docc` extension.
MaxDesiatov
force-pushed
the
maxd/docc-compiler-docs
branch
from
e2c2397 to
984870e
Compare
|
@swift-ci test macos |
|
@swift-ci smoke test |
MaxDesiatov
requested review from
eeckstein,
jckarter and
slavapestov
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds necessary metadata and updates links to Markdown documents in
README.md. Remaining.rstdocuments still need to be converted to Markdown for linking to such documents to work. In the meantime we can convert those to absolute links to GitHub I reckon, but I haven't done that in this PR.You need to have the latest Swift development snapshot installed for rendering to work without renaming the
docsdirectory todocs.docc. A preview of this documentation can be generated with this command on macOSIf you're ok with renaming
docstodocs.docclocally just for preview purposes, you can generate a preview with this command: