Convert Documentation to Vitepress #287
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
ytdHuang
reviewed
Nov 9, 2024
Comment on lines
-32
to
+59
| - uses: actions/checkout@v4 | ||
| - uses: julia-actions/setup-julia@v2 | ||
| with: | ||
| version: '1' | ||
| - uses: julia-actions/cache@v2 | ||
| - uses: julia-actions/julia-buildpkg@v1 | ||
| - uses: julia-actions/julia-docdeploy@v1 | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Julia | ||
| uses: julia-actions/setup-julia@v2 | ||
| - name: Pull Julia cache | ||
| uses: julia-actions/cache@v2 | ||
| - name: Install documentation dependencies | ||
| run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()' | ||
| #- name: Creating new mds from src | ||
| - name: Build and deploy docs | ||
| uses: julia-actions/julia-docdeploy@v1 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | ||
| - run: | | ||
| julia --project=docs -e ' | ||
| using Documenter: DocMeta, doctest | ||
| using QuantumToolbox | ||
| DocMeta.setdocmeta!(QuantumToolbox, :DocTestSetup, :(using QuantumToolbox); recursive=true) | ||
| doctest(QuantumToolbox)' | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token | ||
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key | ||
| GKSwstype: "100" # for Plots.jl plots (if you have them) | ||
| JULIA_DEBUG: "Documenter" | ||
| DATADEPS_ALWAYS_ACCEPT: true |
There was a problem hiding this comment.
I think we don't need to change this part. Better to rebase it
There was a problem hiding this comment.
They said to copy their yaml file. I think that the only difference is the doctest (which we are not doing) and some env variables, right?
ytdHuang
reviewed
Nov 9, 2024
| # ), | ||
| format = DocumenterVitepress.MarkdownVitepress( | ||
| repo = "https://qutip.github.io/QuantumToolbox.jl", | ||
| # deploy_url = "https://qutip.org/QuantumToolbox.jl/", |
There was a problem hiding this comment.
I think we need to uncomment this one
There was a problem hiding this comment.
Yes, I'm unsure. But using Documenter.jl, we didn't specify the deploy_url, everything was pushing to GitHub, like here. So, I think that the link is done in some other place
LorenzoFioroni
pushed a commit
to LorenzoFioroni/QuantumToolbox.jl
that referenced
this pull request
Dec 9, 2024
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.
Description
This PR should already work. I don't know if there is anything else to do. It seems ok.