Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add checker instructions into Read the Docs build #1703

Closed
terriko opened this issue Jun 16, 2022 · 0 comments · Fixed by #1716
Closed

Add checker instructions into Read the Docs build #1703

terriko opened this issue Jun 16, 2022 · 0 comments · Fixed by #1716
Labels
documentation Documentation changes good first issue Good for newcomers

Comments

@terriko
Copy link
Contributor

terriko commented Jun 16, 2022

Right now, the checker instructions live in the checkers readme file: https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/checkers/README.md

I think it would be nice if they were built and linked alongside the other docs on read the docs: https://cve-bin-tool.readthedocs.io/en/latest/

To do this, you'd probably want to add them to https://github.com/intel/cve-bin-tool/blob/main/doc/index.rst and possibly do similar symlink magic we've done with the main README.md file to make it work (your simlink may need to be called CHECKERS.md instead of README.md to avoid conflicts). Then build the docs (instructions) and double-check that it's showing up correctly and nothing looks too confusing in the generated indices.

@terriko terriko added good first issue Good for newcomers documentation Documentation changes labels Jun 16, 2022
@terriko terriko changed the title Add checker instructions into Read the Docs build? Add checker instructions into Read the Docs build Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant