Display README in the Documentation #122
Merged
Conversation
This file contains 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
….jl into ncc/add-readme-in-docs
|
You can see a preview of the docs locally by calling: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'; JULIA_DEBUG=Documenter julia --project=docs docs/make.jl; open docs/build/index.htmlfrom the repo's main directory (not from |
|
OK, now the Docs show all images that are shown in the actual |
|
That's great 👍
…On Wed, Apr 10, 2024, 16:30 Navid C. Constantinou ***@***.***> wrote:
OK, now the Docs show all images that are shown in the actual README.md!
—
Reply to this email directly, view it on GitHub
<#122 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADSKJ2VZTSWQDXLFIE6LWDY4VEI3AVCNFSM6AAAAABF7ZLJYCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANBXG4YTINZZGU>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
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 PR actually displays the README file in the main page of the Documentation instead of pointing users to go read the README file. It's not totally perfect because, as
DocstringExtensionsDocs mention:We can probably modify the README so that it shows up nicely both in the Github Page and in the Docs.Before the docs are built,
make.jlcopies certain image files fromexamples/directory todocs/src/examplesso that when README.md points to them they are show in the Docs version.The PR also adds a functionality that Documenter pushes a preview of how the docs will look after the PR + a Github action that deletes that preview when the PR is merged. Unfortunately, this functionality only works from PRs that come from the same repository -- not from a fork of the repo (like this PR is). Therefore, you won't see a preview with this PR...