Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs Package.toml #37

Closed
0x0f0f0f opened this issue Mar 17, 2021 · 4 comments
Closed

Fix docs Package.toml #37

0x0f0f0f opened this issue Mar 17, 2021 · 4 comments

Comments

@0x0f0f0f
Copy link
Member

For the docs folder, I have to manually add dependencies to docs/Package.toml.

In docs/make.jl I run

include("../src/Metatheory.jl")

How do I specify in docs/Package.toml that I want to include the (unstaged, uncommitted) files and modules from the parent ../src folder, and automatically handle dependencies?

@giordano
Copy link
Contributor

giordano commented Mar 17, 2021

You should not have your package in docs/Project.toml. When you build documentation on CI, your package is automatically dev'ed: https://github.com/julia-actions/julia-docdeploy/blob/2ba07414e6f6cbf6d8a6d23d6f6b8242d56d8e04/action.yml#L20. The alternative is to have docs/Manifest.toml pointing to .. for Metatheory. But I don't like manifests for these things 🙂

@giordano
Copy link
Contributor

But to be clear, do you use to build documentation locally and that's where you're having problems?

@0x0f0f0f
Copy link
Member Author

Yes. Should I just re-use the same command use for CI locally and delete docs/Package.toml?

@giordano
Copy link
Contributor

Yes. Should I just re-use the same command use for CI locally

That's exactly what I do, yes

and delete docs/Package.toml?

Not delete, but don't commit the changes. docs/Project.toml should always only have Documenter (or any other extra package that isn't a dependency of your package)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants