add github-actions documentation - #1172
Conversation
sigmavirus24
left a comment
There was a problem hiding this comment.
I think you also need to add this elsewhere for it to be included in a table of contents and be built and indexed properly
|
@sigmavirus24, I did the recommended changes, can you check it again? |
|
@sigmavirus24 I did the changes, can you check again |
|
I left specific comments but please look at the other rst files to understand the proper way to write RST and follow the same general style |
|
@sigmavirus24 can you check the changes again, I looked at your suggestions and other |
|
Output of the docs build: https://bandit--1172.org.readthedocs.build/en/1172/ |
ericwb
left a comment
There was a problem hiding this comment.
This doc needs to be included as part of the index, otherwise it won't be part of the build output (except a direct link).
|
I added |
|
That is not what Eric meant |
|
The file needs to be referenced in a toctree from an existing document. Now that index you generated is also a leaf |
|
@sigmavirus24 @ericwb I think I did what you guys asked, can you check again |
|
@ericwb @sigmavirus24 completed all the suggestions, can you guys check again |
There was an issue about documentations in GitHub Actions and had to look for the GitHub repo, added GitHub Actions documentation in ci-cd part to make sure it can easily be learned and utilised for CI/CD without further research for users