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

Add script for local doctests #74

Closed
AshlinHarris opened this issue May 17, 2022 · 1 comment · Fixed by #75 or #87
Closed

Add script for local doctests #74

AshlinHarris opened this issue May 17, 2022 · 1 comment · Fixed by #75 or #87
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@AshlinHarris
Copy link
Contributor

No description provided.

@AshlinHarris AshlinHarris added the documentation Improvements or additions to documentation label May 17, 2022
@AshlinHarris AshlinHarris self-assigned this May 17, 2022
@AshlinHarris AshlinHarris linked a pull request May 17, 2022 that will close this issue
@AshlinHarris AshlinHarris linked a pull request May 25, 2022 that will close this issue
@AshlinHarris
Copy link
Contributor Author

For building documentation locally, I comment out the call to deploydocs() from docs/make.jl. Of course, having 2 nearly identical Makefiles in the repository isn't ideal. Instead, this StackOverflow page gives some context on maintaining local versions of files:

git update-index --assume-unchanged docs/make.jl

will ignore local changes, but docs/make.jl is rewritten after a pull. Alternatively,

git update-index --skip-worktree docs/make.jl

does the same but persists after a pull. Neither command has any effect on other users; anyone who wants the same behaviour needs to run one of these commands locally before editing docs/make.jl.

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

Successfully merging a pull request may close this issue.

1 participant