add :api_reference option #899
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #898
This PR adds an option,
:api_reference
, allowing the pageapi-reference.html
to be disabled. It defaults totrue
, which is consistent with existing behavior.When set to false,
build_api_reference/2
is not called when generating the list of extras, and the textor using our <a href="api-reference.html" title="API Reference">API Reference</a> page
is not included in404.html
.This PR also fixes a missing space in the moduledoc for
Mix.Tasks.Docs
.