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.

Sign up for GitHub

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

Jump to bottom

Remove double doctest run, add strict doctest #560

Closed
wants to merge 1 commit into from
Closed

Remove double doctest run, add strict doctest #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,7 @@ jobs:
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- name: Test docs # Test are also run in the makedocs, but there they don't error properly unless we set strict in which case warnings also error
run: |
julia --project=docs -e '
ENV["PLOTS_TEST"] = "true"
ENV["GKSwstype"] = "nul"
using Documenter: doctest
using ControlSystems
doctest(ControlSystems)'
- name: Generate documentation
- name: Make documentation, run doctest
run: julia --project=docs --color=yes docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8 changes: 7 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ println("Making docs")
makedocs(modules=[ControlSystems],
format=Documenter.HTML(),
sitename="ControlSystems.jl",
#strict=true,
strict=[
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know exactly which ones we want here, they are not well explained but the names are decently explanatory. See https://github.com/JuliaDocs/Documenter.jl/pull/1689/files#diff-2c620811ba00ffd5e7b818bdefbab47fe9d7e3e11d046e6fe18e5c01fdff3f0cR227

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the ones you have chosen seem appropriate. I guess :setup_block always leads to downstream failures if it fails in a meaningful way.

Me might want to check :cross_references?

:doctest,
:linkcheck,
:parse_error,
# Other available options are
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
],
pages=[
"Home" => "index.md",
"Guide" => Any[
Expand Down