Add teardown phase to doctests

.gitignore

@@ -16,6 +16,7 @@ test/prerender/build/
 test/themes/dev/
 test/workdir/builds/
 test/quietly-logs/
+test/docsxref/
 docs/dev/
 docs/build/
 docs/build-pdf/

src/DocMeta.jl

@@ -12,6 +12,7 @@ module — a special variable is created in each module that has documentation m
 # Supported metadata
 
 * `DocTestSetup`: contains the doctest setup code for doctests in the module.
+* `DocTestTeardown`: contains the doctest teardown code for doctests in the module.
 """
 module DocMeta
 import ..Documenter
@@ -26,7 +27,10 @@ const METAMODULES = Module[]
 const METATYPE = Dict{Symbol,Any}
 
 "Dictionary of all valid metadata keys and their types."
-const VALIDMETA = Dict{Symbol,Type}(:DocTestSetup => Union{Expr,Symbol})
+const VALIDMETA = Dict{Symbol,Type}(
+ :DocTestSetup => Union{Expr,Symbol},
+ :DocTestTeardown => Union{Expr,Symbol}
+)
 
 """
 """

src/doctests.jl

@@ -198,6 +198,17 @@ function _doctest(ctx::DocTestContext, block_immutable::MarkdownAST.CodeBlock)
  ```
  """)
  end
+ for expr in [get(ctx.meta, :DocTestTeardown, []); get(ctx.meta[:LocalDocTestArguments], :teardown, [])]
+ Meta.isexpr(expr, :block) && (expr.head = :toplevel)
+ try
+ Core.eval(sandbox, expr)
+ catch e
+ push!(ctx.doc.internal.errors, :doctest)
+ @error("could not evaluate expression from doctest teardown.",
+ expression = expr, exception = e)
+ return false
+ end
+ end
  delete!(ctx.meta, :LocalDocTestArguments)
  end
  false

src/expander_pipeline.jl

@@ -293,7 +293,7 @@ function Selectors.runner(::Type{Expanders.MetaBlocks}, node, page, doc)
  # wants to hide. We should probably warn, but it is common enough that
  # we will silently skip for now.
  if Documenter.isassign(ex)
- if !(ex.args[1] in (:CurrentModule, :DocTestSetup, :DocTestFilters, :EditURL, :Description, :Draft, :CollapsedDocStrings))
+ if !(ex.args[1] in (:CurrentModule, :DocTestSetup, :DocTestTeardown, :DocTestFilters, :EditURL, :Description, :Draft, :CollapsedDocStrings))
  source = Documenter.locrepr(page.source, lines)
  @warn(
  "In $source: `@meta` block has an unsupported " *