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

Documentation action fails #60

Closed
AshlinHarris opened this issue May 11, 2022 · 2 comments · Fixed by #75
Closed

Documentation action fails #60

AshlinHarris opened this issue May 11, 2022 · 2 comments · Fixed by #75

Comments

@AshlinHarris
Copy link
Contributor

The documentation action fails if any functions aren't included in the docs. However, Documenter.jl pulls from the remote repo, so functions cannot be added until they exist in the main repo.

@DilumAluthge
Copy link
Member

This isn't quite correct. The docs are built from the PR branch, so there's no chicken/egg issue here. You just need to make sure that all of your docstrings show up somewhere in the manual.

@AshlinHarris
Copy link
Contributor Author

Oh, my mistake! I was testing by building the docs locally. Thank you!

@AshlinHarris AshlinHarris linked a pull request May 17, 2022 that will close this issue
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

Successfully merging a pull request may close this issue.

2 participants