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

Allow automated test missingdocs #1995

Merged
merged 4 commits into from
Dec 21, 2022
Merged

Allow automated test missingdocs #1995

merged 4 commits into from
Dec 21, 2022

Conversation

KeithWM
Copy link
Contributor

@KeithWM KeithWM commented Dec 13, 2022

We wish to use the missingdocs functionality in a CI/CD environment. For this, it is useful to have the missingdocs function not only print out missing documentation, but also return the number of missing documents. This can then be verified using a @test missingdocs(...) == 0.

@mortenpi
Copy link
Member

LGTM, thanks! Something to note here though is that missingdocs is not actually part of Documenter's API. But it's also unlikely to go anywhere or change it's semantics any time soon.

@mortenpi mortenpi merged commit 55eeeff into JuliaDocs:master Dec 21, 2022
@KeithWM KeithWM deleted the allow-automated-test-missingdocs branch January 13, 2023 10:44
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.

None yet

2 participants