Skip to content

Commit 240f934

Browse files
author
Matthew Ballance
committed
Fix doc paths to be readthedocs friendly
Signed-off-by: Matthew Ballance <matt.ballance@gmail.com>
1 parent 45d2480 commit 240f934

4 files changed

Lines changed: 15 additions & 13 deletions

File tree

doc/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
lxml
3+
pyyaml
34
python-jsonschema-objects
45
jsonschema
56
sphinx-jsonschema

doc/source/reference/coverage_report_json.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@ The JSON coverage-report format is a direct transcription of the
1111
Coverage Report Object API.
1212

1313

14-
.. jsonschema:: ../../schema/covreport.json
14+
.. jsonschema:: ../../../src/ucis/schema/covreport.json
1515

16-
.. jsonschema:: ../../schema/covreport.json#/defs/coverageReportType
16+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/coverageReportType
1717

18-
.. jsonschema:: ../../schema/covreport.json#/defs/typeCovergroupType
18+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/typeCovergroupType
1919

20-
.. jsonschema:: ../../schema/covreport.json#/defs/instCovergroupType
20+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/instCovergroupType
2121

22-
.. jsonschema:: ../../schema/covreport.json#/defs/coverpointType
22+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/coverpointType
2323

24-
.. jsonschema:: ../../schema/covreport.json#/defs/crossType
24+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/crossType
25+
26+
.. jsonschema:: ../../../src/ucis/schema/covreport.json#/defs/coverBinType
2527

26-
.. jsonschema:: ../../schema/covreport.json#/defs/coverBinType

doc/source/reference/recording_coverage_base_practices.rst renamed to doc/source/reference/recording_coverage_best_practices.rst

File renamed without changes.

doc/source/reference/yaml_coverage.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ tools to create and process.
1010
Format Reference
1111
================
1212

13-
.. jsonschema:: ../../schema/coverage.json
13+
.. jsonschema:: ../../../src/ucis/schema/coverage.json
1414

1515
Every coverage-data document has a `coverage` element as its root. Currently,
1616
the only sub-elements is a list of covergroup types.
1717

18-
.. jsonschema:: ../../schema/coverage.json#/defs/covergroupType
18+
.. jsonschema:: ../../../src/ucis/schema/coverage.json#/defs/covergroupType
1919

2020
A type covergroup provides data about a covergroup type. All instances
2121
of a covergroup type have the same coverpoints and crosses. All
@@ -24,26 +24,26 @@ Merged type coverage (the union of coverage achieved by all instances)
2424
is derived by PyUCIS from the instance coverage, and is not specified
2525
in the coverage file.
2626

27-
.. jsonschema:: ../../schema/coverage.json#/defs/covergroupInstType
27+
.. jsonschema:: ../../../src/ucis/schema/coverage.json#/defs/covergroupInstType
2828

2929
An instance covergroup provides data about a covergroup instance.
3030

3131

32-
.. jsonschema:: ../../schema/coverage.json#/defs/coverpointType
32+
.. jsonschema:: ../../../src/ucis/schema/coverage.json#/defs/coverpointType
3333

3434
A coverpoint lists a set of bins that it is monitoring. Each
3535
coverpoint can specify an `atleast` count to specify that a
3636
bin must contain `atleast` hits in order to count as being covered.
3737
By default, `atleast` is 1.
3838

39-
.. jsonschema:: ../../schema/coverage.json#/defs/crossType
39+
.. jsonschema:: ../../../src/ucis/schema/coverage.json#/defs/crossType
4040

4141
A cross lists the set of coverpoints from which it is composed,
4242
and lists its cross bins. Each cross can specify an `atleast`
4343
count to specify that a bin must contain `atleast` hits in
4444
order to count as being covered. By default, `atleast` is 1.
4545

46-
.. jsonschema:: ../../schema/coverage.json#/defs/coverBinType
46+
.. jsonschema:: ../../../src/ucis/schema/coverage.json#/defs/coverBinType
4747

4848
A coverbin associates a bin name with the number of hits
4949
in that bin.

0 commit comments

Comments
 (0)