Skip to content

Commit bd4178a

Browse files
committed
fix: fix sphinx documentation
All documentation must be in doc directory to allow sphinx to correctly generate it, so move all documentation in doc instead of adding links from doc to upper directories While at it, also fix other sphinx errors/issues: - README.html -> README.md - yml -> yaml - csv -> text - html -> jinja - Remove ... from json - Remove ---------------------- from markdown - Use local links instead of https://github.com/ossf/cve-bin-tool (it is portable and works both with markdown and sphinx) Signed-off-by: Fabrice Fontaine <[email protected]>
1 parent 4ba1665 commit bd4178a

22 files changed

+1677
-1684
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 505 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc/CONTRIBUTING.md

README.md

Lines changed: 0 additions & 577 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc/README.md

cve_bin_tool/checkers/README.md

Lines changed: 0 additions & 540 deletions
This file was deleted.

cve_bin_tool/checkers/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../doc/checkers/README.md

cve_bin_tool/parsers/README.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

cve_bin_tool/parsers/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../doc/parsers/README.md

doc/CHECKERS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../cve_bin_tool/checkers/README.md
1+
checkers/README.md

doc/CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)