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

Setting "strict mode" in docs build throws error #363

Closed
vikram-s-narayan opened this issue Jun 26, 2022 · 0 comments · Fixed by #383
Closed

Setting "strict mode" in docs build throws error #363

vikram-s-narayan opened this issue Jun 26, 2022 · 0 comments · Fixed by #383

Comments

@vikram-s-narayan
Copy link
Contributor

vikram-s-narayan commented Jun 26, 2022

We're getting an error ("ERROR: makedocs encountered an error (:docs_block, :example_block). Terminating build before rendering.") without being able to create the build directory when we make the following change in make.jl:

makedocs(
    sitename="Surrogates.jl",

    strict = [
             :doctest,
             :linkcheck,
             :parse_error,
             :example_block,
             # Other available options are
             # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
         ],
         
    format = Documenter.HTML(analytics = "UA-90474609-3",
                         assets = ["assets/favicon.ico"],
                         canonical="https://surrogates.sciml.ai/stable/"),
    pages = pages
)

Each page in docs will need to be fixed independently in order to make these tests pass.

More context for 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.

1 participant