Skip to content

add github-actions documentation - #1172

Merged
lukehinds merged 8 commits into
PyCQA:mainfrom
Killpit:main
Jun 15, 2025
Merged

add github-actions documentation#1172
lukehinds merged 8 commits into
PyCQA:mainfrom
Killpit:main

Conversation

@Killpit

@Killpit Killpit commented Sep 17, 2024

Copy link
Copy Markdown
Contributor

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

@sigmavirus24 sigmavirus24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
@Killpit

Killpit commented Sep 18, 2024

Copy link
Copy Markdown
Contributor Author

@sigmavirus24, I did the recommended changes, can you check it again?

@Killpit

Killpit commented Dec 16, 2024

Copy link
Copy Markdown
Contributor Author

@sigmavirus24 I did the changes, can you check again

Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
@sigmavirus24

Copy link
Copy Markdown
Member

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

@Killpit

Killpit commented Dec 22, 2024

Copy link
Copy Markdown
Contributor Author

@sigmavirus24 can you check the changes again, I looked at your suggestions and other .rst files to format the changes and also formatted the list table to further be compliant with the .rst rules. Even had a last commit

@ericwb

ericwb commented Feb 20, 2025

Copy link
Copy Markdown
Member

Output of the docs build: https://bandit--1172.org.readthedocs.build/en/1172/

@ericwb ericwb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@Killpit

Killpit commented Feb 20, 2025

Copy link
Copy Markdown
Contributor Author

I added index.rst similar to other directories, can you review it again? @sigmavirus24 @ericwb

@sigmavirus24

Copy link
Copy Markdown
Member

That is not what Eric meant

@sigmavirus24

Copy link
Copy Markdown
Member

The file needs to be referenced in a toctree from an existing document. Now that index you generated is also a leaf

@Killpit

Killpit commented Feb 21, 2025

Copy link
Copy Markdown
Contributor Author

@sigmavirus24 @ericwb I think I did what you guys asked, can you check again

Comment thread doc/source/ci-cd/index.rst Outdated
Comment thread doc/source/ci-cd/index.rst Outdated
Comment thread doc/source/ci-cd/index.rst Outdated
Comment thread doc/source/index.rst
Comment thread doc/source/ci-cd/index.rst Outdated
Comment thread doc/source/ci-cd/index.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
Comment thread doc/source/ci-cd/github-actions.rst Outdated
@Killpit

Killpit commented Feb 23, 2025

Copy link
Copy Markdown
Contributor Author

@ericwb @sigmavirus24 completed all the suggestions, can you guys check again

@lukehinds
lukehinds merged commit 61d1667 into PyCQA:main Jun 15, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants