vhdl-style-guide/docs
Matteo Delton 7bffafae0e
Fix typo and quote relativeFile (#1129)
"autodetect" is not accepted, while "autoDetect" is
Without quotes, an error is thrown if relativeFile contains spaces
2024-02-21 06:42:49 -06:00
..
editor_integration Fix typo and quote relativeFile (#1129) 2024-02-21 06:42:49 -06:00
img Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
rule_groups Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
theory_of_operation Issue#880 Adding tokeninzing, tokens and classifying documentation. 2024-02-01 20:57:43 -06:00
tool_integration alonbl patch series (#1017) 2023-11-05 07:24:50 -06:00
Makefile
…
after_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
alias_declaration_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
api.rst
…
architecture_rules.rst Adding structure::optional tag to rule architecture_010. 2022-10-21 19:09:11 -05:00
assert_rules.rst Issue#1082: Adding assert rules to match report statement rules functionality. (#1083) 2024-01-01 19:07:46 -06:00
attribute_declaration_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
attribute_rules.rst Updates for issue #777 (#779) 2022-05-08 08:56:47 -05:00
attribute_specification_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
block_comment_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
block_rules.rst Issue#1061: Updates for pragma use cases (#1063) 2023-12-12 06:41:06 -06:00
case_generate_alternative_rules.rst Issue#1104 Corrected "superceeced" typo. (#1105) 2024-01-20 12:41:23 -06:00
case_generate_statement_rules.rst Issue 800 (#804) 2022-07-15 06:25:45 -05:00
case_rules.rst Issue#1104 Corrected "superceeced" typo. (#1105) 2024-01-20 12:41:23 -06:00
code_tags.rst Updates for issue #750 (#752) 2022-04-10 20:10:49 -05:00
comment_rules.rst Issue#927: Adding checks for keywords in comments. (#934) 2023-04-11 10:48:39 -05:00
component_rules.rst #871 (#872): Updating documentation links. 2022-11-13 12:02:54 -06:00
concurrent_rules.rst Issue#882: Moving rule concurrent_007 to conditional_waveforms_001. (#1049) 2023-12-09 08:00:40 -06:00
conditional_expressions_rules.rst Updates for issue #825 (#826) 2022-09-25 12:44:25 -05:00
conditional_waveforms_rules.rst Issue#882: Moving rule concurrent_007 to conditional_waveforms_001. (#1049) 2023-12-09 08:00:40 -06:00
conf.py Attempting to fix readthedocs formatting. 2023-09-10 17:32:16 -05:00
configuring.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
configuring_array_multiline_structure_rules.rst Issue 549a (#839) 2022-10-20 18:24:42 -05:00
configuring_blank_lines.rst Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068) 2023-12-17 16:59:55 -06:00
configuring_block_comments.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_comment_keywords.rst Issue#927: Adding checks for keywords in comments. (#934) 2023-04-11 10:48:39 -05:00
configuring_conditional_multiline_indent_rules.rst Issue 1033: Fixing classification of commas in selected_waveforms. (#1038) 2023-10-29 10:36:54 -05:00
configuring_consecutive_blank_line_rules.rst Updates for issue #846 (#848) 2022-10-21 06:41:17 -05:00
configuring_disabled_rules.rst Issue#1112 Corrected list of disabled rules and added unit test to verify list. (#1113) 2024-01-21 13:30:18 -06:00
configuring_identifier_alignment_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_indent_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_indentation.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
configuring_keyword_alignment_rules.rst Issue#1107: Adding option to process_028 to allow for alignment of close parenthesis. (#1116) 2024-01-24 06:56:17 -06:00
configuring_length_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
configuring_move_token_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_multiline_assert_rule.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_multiline_constraint_rules.rst Updates for issue #539 (#751) 2022-07-08 08:26:29 -05:00
configuring_multiline_indent_rules.rst Issue#1127: Corrected formatting for code block in "Configuring Multiline Indent Rules" page. (#1128) 2024-02-15 21:17:44 -06:00
configuring_number_of_signals_in_signal_declaration.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
configuring_optional_items.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_overview.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
configuring_port_mode_alignment.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_pragmas.rst Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068) 2023-12-17 16:59:55 -06:00
configuring_prefix_and_suffix_rules.rst Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111) 2024-01-21 13:02:00 -06:00
configuring_previous_line_rules.rst Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068) 2023-12-17 16:59:55 -06:00
configuring_procedure_call_statement_rules.rst Issue#1106 Corrections to procedure call docs. (#1109) 2024-01-21 12:42:40 -06:00
configuring_rule_groups.rst Issue#973: Correcting typo in code example on Configuring Rule Groups page. (#974) 2023-08-06 11:13:19 -05:00
configuring_selected_assignment_structure_rules.rst Issue 850 (#861) 2022-12-13 18:06:54 -06:00
configuring_simple_multiline_structure_rules.rst Issue#1006: Minor documentation fixes (#1007) 2023-10-24 16:31:48 -05:00
configuring_subprogram_specification_statement_rules.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
configuring_type_of_instantiations.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_uppercase_and_lowercase_rules.rst Issue#1082: Adding assert rules to match report statement rules functionality. (#1083) 2024-01-01 19:07:46 -06:00
configuring_use_clause_indenting.rst Issue#1030: Adding option to indent use_clauses depending on existence of library_clause. (#1031) 2023-10-27 17:01:57 -05:00
configuring_vhdl_reserved_words.rst Issue#1053: Adding rule to check for reserved words. (#1055) 2023-12-01 07:41:39 -06:00
configuring_whitespace_after_comment_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_whitespace_rules.rst Issue#1082: Adding assert rules to match report statement rules functionality. (#1083) 2024-01-01 19:07:46 -06:00
constant_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
context_ref_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
context_rules.rst #871 (#872): Updating documentation links. 2022-11-13 12:02:54 -06:00
continuous_integration_servers.rst Updates for issue #596 (#787) 2022-08-01 21:04:35 -05:00
contributing.rst Fix broken links to Subprogram Body Rules (#786) 2022-05-16 18:31:23 -05:00
declarative_part_rules.rst Issue 864 (#895) 2022-12-13 18:05:24 -06:00
element_association_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
entity_rules.rst Issue#992: Added all optional item rules to `structure::optional` rule group. (#993) 2023-09-08 15:41:39 -05:00
entity_specification_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
example_configuration_json_file.json
…
exit_statement_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
exponent_rules.rst Updates for issue #750 (#752) 2022-04-10 20:10:49 -05:00
file_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
for_generate_statement_rules.rst Updates for issue #689: (#737) 2022-02-20 07:47:14 -06:00
for_loop_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
formatting_terminal_output.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
function_rules.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
gallery.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
generate_rules.rst Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111) 2024-01-21 13:02:00 -06:00
generic_map_rules.rst #871 (#872): Updating documentation links. 2022-11-13 12:02:54 -06:00
generic_rules.rst #871 (#872): Updating documentation links. 2022-11-13 12:02:54 -06:00
icons.rst
…
ieee_rules.rst Updates for issue #729 (#731) 2022-02-09 20:16:02 -06:00
if_generate_statement_rules.rst Updates for issue #780: (#781) 2022-05-16 18:34:27 -05:00
if_rules.rst Issue#1104 Corrected "superceeced" typo. (#1105) 2024-01-20 12:41:23 -06:00
includes.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
index.rst alonbl patch series (#1017) 2023-11-05 07:24:50 -06:00
installing.rst #898 (#899): Updating installation instructions when using pip. 2022-12-09 12:08:33 -06:00
instantiation_rules.rst Issue#942: Moved rule instantiation_023 to port_map_010. (#958) 2023-10-24 16:34:13 -05:00
iteration_scheme_rules.rst Issue#1084: Updated docstring for `iteration_scheme_501`. (#1085) 2024-01-01 18:41:42 -06:00
length_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
library_rules.rst Issue#1030: Adding option to indent use_clauses depending on existence of library_clause. (#1031) 2023-10-27 17:01:57 -05:00
links.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
localizing.rst Issue#1117 Modifed initialisation of the `Rule` class's `name` and `identifier` attributes to reduce duplication. (#1118) 2024-02-04 15:23:23 -06:00
logical_operator_rules.rst Updates for issue #702 (#738) 2022-02-12 14:58:38 -06:00
loop_statement_rules.rst Issue#1110 Added rules to enforce prefixes and suffixes on generate/loop parameter indentifiers (#1111) 2024-01-21 13:02:00 -06:00
make.bat
…
multiple_configurations.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
notepad_pp.rst Updates for issue #777 (#779) 2022-05-08 08:56:47 -05:00
overview.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
package_body_rules.rst Issue#992: Added all optional item rules to `structure::optional` rule group. (#993) 2023-09-08 15:41:39 -05:00
package_rules.rst Issue#992: Added all optional item rules to `structure::optional` rule group. (#993) 2023-09-08 15:41:39 -05:00
phases.rst
…
port_map_rules.rst Issue#942: Moved rule instantiation_023 to port_map_010. (#958) 2023-10-24 16:34:13 -05:00
port_rules.rst #871 (#872): Updating documentation links. 2022-11-13 12:02:54 -06:00
pragma_rules.rst Issue#1065: Adding 'require_blank_line_unless_pragma' to blank line rules (#1068) 2023-12-17 16:59:55 -06:00
pragmas.rst
…
procedure_call_rules.rst Issue#1074: procedure_call_003 now includes sequential procedure calls. (#1075) 2023-12-21 08:34:44 -06:00
procedure_rules.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
process_rules.rst Issue#1107: Adding option to process_028 to allow for alignment of close parenthesis. (#1116) 2024-01-24 06:56:17 -06:00
range_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
record_type_definition_rules.rst Updates for Issue 775 (#782) 2022-06-03 08:03:11 -05:00
release_notes.rst Fixing link to release notes. 2022-05-06 07:56:06 -05:00
release_process.rst Commenting out old release method. 2022-11-07 06:11:07 -06:00
report_statement_rules.rst Updates for issue #559: (#798) 2022-10-07 08:01:03 -05:00
requirements.txt Bump readthedocs-sphinx-search from 0.1.1 to 0.3.2 in /docs (#1099) 2024-02-19 07:24:07 -06:00
reserved_rules.rst Issue#1053: Adding rule to check for reserved words. (#1055) 2023-12-01 07:41:39 -06:00
return_statement_rules.rst Issue-945: Adding rules for return_statement production (#1020) 2023-10-22 06:44:48 -05:00
rule_groups.rst Issue #837 (#903): Adding listing of rules in rule groups. 2022-12-21 11:51:29 -06:00
rule_severity.rst
…
rules.rst Issue#1054: Adding classification of pragmas. (#1056) 2023-12-03 21:09:52 -06:00
selected_assignment_rules.rst Issue 850 (#861) 2022-12-13 18:06:54 -06:00
sequential_rules.rst Issue 549a (#839) 2022-10-20 18:24:42 -05:00
setting_up_a_development_environment.rst
…
signal_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
source_file_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
styles.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
subprogram_body_rules.rst Updates for issue #784: (#785) 2022-05-16 18:25:58 -05:00
subtype_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
type_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
update.sed Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
usage.rst alonbl patch series (#1017) 2023-11-05 07:24:50 -06:00
use_clause_rules.rst Updates for issue #730 (#741) 2022-04-19 19:21:20 -05:00
variable_assignment_rules.rst Issue 549a (#839) 2022-10-20 18:24:42 -05:00
variable_rules.rst Issue 815 (#840) 2023-12-09 08:03:07 -06:00
vsg.rule_list.rst
…
vsg.vhdlFile.rst
…
wait_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
when_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
while_loop_rules.rst Changing links to configuration documentation into ReST substitations. 2022-02-05 15:13:48 -06:00
whitespace_rules.rst Updates for issue #846 (#848) 2022-10-21 06:41:17 -05:00
with_rules.rst Issue 850 (#861) 2022-12-13 18:06:54 -06:00