Fix building docs locally - #32
Open
KnutAM wants to merge 3 commits into
Open
Conversation
kimauth
reviewed
Aug 13, 2021
|
|
||
| [compat] | ||
| Documenter = "0.26" No newline at end of file | ||
| Documenter = "0.26" |
Owner
There was a problem hiding this comment.
Suggested change
| Documenter = "0.26" | |
| Documenter = "0.27" |
Owner
|
I think for building the docs locally you still need to make sure you add |
kimauth
approved these changes
Aug 13, 2021
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Following discourse I ran
julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'[1]This adds
MaterialModelsto thedocs/Project.toml. Then, runningjulia --project=docs/ docs/make.jl[2]builds the documentation locally just fine.
So I guess [1] is only required the first time to generate the Manifest (and download packages if required) and [2] each time one wants to build the docs?
We could also include a compat section for documenter as in Fredrik's post above I guess...(Sorry about the back and forth, did not realize [compat] was already there from before...)