DOC bring back numbering for user guide, raise build issues as errors, and fix warnings #549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rdheekonda
reviewed
Nov 13, 2024
rdheekonda
reviewed
Nov 13, 2024
rdheekonda
approved these changes
Nov 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR brings back numbering so that the user guide is easier to follow. Each section either has a number or the suffix "optional" to indicate how essential this functionality is to understanding PyRIT. The "landing page" for each section gets number 0 which is not displayed. This required shifting indices down by 1 in most sections.
Example:
Also, I noticed the word "optional" in lowercase is causing lots of build warnings so I replaced it with capital "Optional".
A few files already had build errors so I turned on the
-Wflag in the build pipeline to raise these as errors.Tests and Documentation