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 the deploy_folder fallbacks and the docstring for deploy_folder #1315

Merged
merged 6 commits into from
May 7, 2020
Merged

Fix the deploy_folder fallbacks and the docstring for deploy_folder #1315

merged 6 commits into from
May 7, 2020

Conversation

DilumAluthge
Copy link
Contributor

No description provided.

@DilumAluthge
Copy link
Contributor Author

@mortenpi @fredrikekre I think this should fix the deploy_docs stuff and the docstrings that Fredrik mentioned.

@DilumAluthge DilumAluthge reopened this May 5, 2020
@DilumAluthge
Copy link
Contributor Author

DilumAluthge commented May 5, 2020

I tried to add a docstring for DeployDecision. But this broke LinkCheck. When I removed the docstring for DeployDecision, then LinkCheck passed.

This is the docstring I tried to add:

"""
    DeployDecision(; kwargs...)
Struct containing information about the decision to deploy or not deploy.
# Arguments
- `all_ok::Bool` - Should documentation be deployed?
- `branch::String` - The branch to which documentation should be pushed
- `is_preview::Bool` - Is this documentation build a pull request?
- `repo::String` - The repo to which documentation should be pushed
- `subfolder::String` - The subfolder to which documentation should be pushed
"""

@mortenpi
Copy link
Member

mortenpi commented May 5, 2020

I re-added the docstring, let's see what happens. I don't see anything in it that should cause linkcheck to fail. However, Travis and AppVeyor tests were both failing too, without the docstring.

@DilumAluthge
Copy link
Contributor Author

DilumAluthge commented May 6, 2020

All right I think I should've fixed the tests now.

@DilumAluthge
Copy link
Contributor Author

Okay, CI is passing now.

@DilumAluthge
Copy link
Contributor Author

@mortenpi @fredrikekre Anything else I should add to this PR?

@mortenpi mortenpi merged commit b1e7047 into JuliaDocs:master May 7, 2020
@DilumAluthge DilumAluthge deleted the patch-2 branch May 7, 2020 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants