Improvements to help tests #698
Merged
Conversation
This file contains hidden or 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
Instead use `Page(None,name). This change allows pages without parents to be leaf pages, which again helps with tests.
Drup
reviewed
Jul 5, 2021
| kind : string; | ||
| kind : kind; | ||
| (** What kind of element the path points to. | ||
| e.g. "module", "module-type", "exception", ... *) |
There was a problem hiding this comment.
The documentation should change I guess.
There was a problem hiding this comment.
Good point, will follow up :-)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is a set of changes primarily aimed at making tests easier to run. The main changes are:
Flat output for HTML - in this mode HTML files for nested modules/module types/classes/class types that would ordinarily have been output into a directory tree will now be output into a single directory. The motivation for this is that dune does not currently cope well with targets in different directories, so this sidesteps the issue. The change is minimally invasive, so even though this is not the default mode we expect to use, tests run using this mode should be a reliable indicator of how it should behave in the usual case. All of the links should still work.
Compilation units may now be compiled without a parent page. This is a convenience for tests, and allows the different output renderers to place the files in an analogous structure.
A new argument
--extra-suffixfor all generators allows the tests to specify that output filenames should have an additional suffix appended onto them. This allows tests to render e.g.index.html.genand then arrange for this to be diffed with and promoted toindex.html