[DRAFT] Add documentation generation #945
Closed
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.
Adds the
--docs
flag to the hive binary, which has the following effects:HIVE_DOCS_MODE
environment variable for the simulator container, which does the following:hivesim
library being used by (currently) all simulators and inhibit the execution of test functions that are not marked asAlwaysRun
StartSuite
,EndSuite
,StartTest
andEndTest
requests to the hive serverTestManager
, the hive server collects the test suites and test cases and then proceeds to generate a markdown document for each suite containing every single test case into the simulator folderThe following fields are added to many structures, including the
TestRequest
,TestSuite
andTestCase
:In its current state, simulators still execute each test case in full because the
hivesim
dependency that inhibits execution in docs mode needs to be updated once this change makes it into the master branch.