Add a siteinfo JSON file generated by makedocs #2181
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mortenpi
added
Type: Enhancement
Format: HTML
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A sibling to the
siteinfo.jsfile generated bydeploydocs. The point here is that this one will always be generated, but will not actually be read by the HTML. Instead, this can be used by external tools, like DocumenterTools, to figure out what version of Documenter was used to generate the docs etc.We could try to re-use
siteinfo.jsfor this new metadata as well, but it is convenient if the metadata is in a standard, structured format that can easily be parsed.siteinfo.jsmust be valid top-level JS, and therefore would need a custom parser.