-
Notifications
You must be signed in to change notification settings - Fork 5
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
0.0.6dev #31
0.0.6dev #31
Conversation
documentation category dropdowns now work
improved rect documentation fixed getTicks
more doc changes provided a requirements.txt for future contributors
@@ -35,22 +35,22 @@ | |||
|
|||
on_rtd = os.environ.get("READTHEDOCS", None) == "True" | |||
if on_rtd: | |||
subprocess.call('doxygen', shell=True) | |||
subprocess.call("doxygen", shell=True) |
Check notice
Code scanning / Bandit (reported by Codacy)
Starting a process with a partial executable path Note documentation
@@ -35,22 +35,22 @@ | |||
|
|||
on_rtd = os.environ.get("READTHEDOCS", None) == "True" | |||
if on_rtd: | |||
subprocess.call('doxygen', shell=True) | |||
subprocess.call("doxygen", shell=True) |
Check notice
Code scanning / Bandit (reported by Codacy)
subprocess call with shell=True seems safe, but may be changed in the future, consider rewriting without shell Note documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check notice
Code scanning / Csslint (reported by Codacy)
Element (dl.simple) is overqualified, just use .simple without element name. Note documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Csslint (reported by Codacy)
Rule doesn't have all its properties in alphabetical order. Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { | |||
border-bottom: 1px solid var(--hr-color); |
Check notice
Code scanning / Csslint (reported by Codacy)
Expected end of value but found 'var(--hr-color)'. Note documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { | |||
border-bottom: 1px solid var(--hr-color); | |||
background: none !important; |
Check notice
Code scanning / Csslint (reported by Codacy)
Use of !important Note documentation
copyright = '2024, Derrick Martinez' | ||
author = 'Derrick Martinez' | ||
project = "Kraken Engine" | ||
copyright = "2024, Derrick Martinez" |
Check warning
Code scanning / Prospector (reported by Codacy)
Redefining built-in 'copyright' (redefined-builtin) Warning documentation
of the documentation... | ||
`; | ||
document.addEventListener("DOMContentLoaded", () => { | ||
const menuHeaders = document.querySelectorAll('.wy-menu-vertical .caption'); |
Check notice
Code scanning / Jshint (reported by Codacy)
Prohibits the use of __iterator__ property due to compatibility issues Note documentation
`; | ||
document.addEventListener("DOMContentLoaded", () => { | ||
const menuHeaders = document.querySelectorAll('.wy-menu-vertical .caption'); | ||
let hasCurrent = false; |
Check notice
Code scanning / Jshint (reported by Codacy)
Prohibits the use of __iterator__ property due to compatibility issues Note documentation
of the documentation. | ||
`; | ||
menuHeaders.forEach(header => { | ||
const connectedMenu = header.nextElementSibling; // The dropdown menu (e.g., `ul`) |
Check notice
Code scanning / Jshint (reported by Codacy)
Prohibits the use of __iterator__ property due to compatibility issues Note documentation
} | ||
// Toggle dropdown visibility on click | ||
header.addEventListener('click', () => { | ||
const isActive = connectedMenu.classList.contains('active'); |
Check notice
Code scanning / Jshint (reported by Codacy)
Prohibits the use of __iterator__ property due to compatibility issues Note documentation
noticeLink.innerHTML = message; | ||
// Close all dropdowns | ||
menuHeaders.forEach(otherHeader => { | ||
const otherMenu = otherHeader.nextElementSibling; |
Check notice
Code scanning / Jshint (reported by Codacy)
Prohibits the use of __iterator__ property due to compatibility issues Note documentation
breathe_projects = {'KrakenEngine': 'xml'} | ||
breathe_default_project = 'KrakenEngine' | ||
breathe_projects = {"KrakenEngine": "xml"} | ||
breathe_default_project = "KrakenEngine" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "breathe_default_project" doesn't conform to UPPER_CASE naming style Warning documentation
else: | ||
notfound_urls_prefix = '' | ||
|
||
templates_path = ["_templates"] | ||
|
||
source_suffix = '.rst' | ||
source_suffix = ".rst" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "source_suffix" doesn't conform to UPPER_CASE naming style Warning documentation
source_encoding = "utf-8-sig" | ||
|
||
master_doc = 'index' | ||
master_doc = "index" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "master_doc" doesn't conform to UPPER_CASE naming style Warning documentation
project = 'Kraken Engine' | ||
copyright = '2024, Derrick Martinez' | ||
author = 'Derrick Martinez' | ||
project = "Kraken Engine" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "project" doesn't conform to UPPER_CASE naming style Warning documentation
copyright = '2024, Derrick Martinez' | ||
author = 'Derrick Martinez' | ||
project = "Kraken Engine" | ||
copyright = "2024, Derrick Martinez" |
Check notice
Code scanning / Pylintpython3 (reported by Codacy)
Redefining built-in 'copyright' Note documentation
copyright = '2024, Derrick Martinez' | ||
author = 'Derrick Martinez' | ||
project = "Kraken Engine" | ||
copyright = "2024, Derrick Martinez" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "copyright" doesn't conform to UPPER_CASE naming style Warning documentation
author = 'Derrick Martinez' | ||
project = "Kraken Engine" | ||
copyright = "2024, Derrick Martinez" | ||
author = "Derrick Martinez" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "author" doesn't conform to UPPER_CASE naming style Warning documentation
@@ -110,4 +101,4 @@ | |||
|
|||
gettext_compact = False | |||
|
|||
epub_tocscope = 'includehidden' | |||
epub_tocscope = "includehidden" |
Check warning
Code scanning / Pylintpython3 (reported by Codacy)
Constant name "epub_tocscope" doesn't conform to UPPER_CASE naming style Warning documentation
@@ -1,15 +1,15 @@ | |||
import os | |||
import subprocess | |||
|
|||
breathe_projects = {'KrakenEngine': 'xml'} | |||
breathe_default_project = 'KrakenEngine' | |||
breathe_projects = {"KrakenEngine": "xml"} |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "breathe_projects" doesn't conform to UPPER_CASE naming style Warning documentation
breathe_projects = {'KrakenEngine': 'xml'} | ||
breathe_default_project = 'KrakenEngine' | ||
breathe_projects = {"KrakenEngine": "xml"} | ||
breathe_default_project = "KrakenEngine" |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "breathe_default_project" doesn't conform to UPPER_CASE naming style Warning documentation
else: | ||
notfound_urls_prefix = '' | ||
|
||
templates_path = ["_templates"] | ||
|
||
source_suffix = '.rst' | ||
source_suffix = ".rst" |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "source_suffix" doesn't conform to UPPER_CASE naming style Warning documentation
source_encoding = "utf-8-sig" | ||
|
||
master_doc = 'index' | ||
master_doc = "index" |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "master_doc" doesn't conform to UPPER_CASE naming style Warning documentation
project = 'Kraken Engine' | ||
copyright = '2024, Derrick Martinez' | ||
author = 'Derrick Martinez' | ||
project = "Kraken Engine" |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "project" doesn't conform to UPPER_CASE naming style Warning documentation
|
||
version = os.getenv("READTHEDOCS_VERSION", "0.0.3") | ||
version = os.getenv("READTHEDOCS_VERSION", "0.0.6") |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "version" doesn't conform to UPPER_CASE naming style Warning documentation
html_js_files = [ | ||
"js/custom.js", | ||
] | ||
html_static_path = ["_static"] |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "html_static_path" doesn't conform to UPPER_CASE naming style Warning documentation
"js/custom.js", | ||
] | ||
html_static_path = ["_static"] | ||
html_css_files = ["css/custom.css"] |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "html_css_files" doesn't conform to UPPER_CASE naming style Warning documentation
] | ||
html_static_path = ["_static"] | ||
html_css_files = ["css/custom.css"] | ||
html_js_files = ["js/custom.js"] |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "html_js_files" doesn't conform to UPPER_CASE naming style Warning documentation
@@ -110,4 +101,4 @@ | |||
|
|||
gettext_compact = False | |||
|
|||
epub_tocscope = 'includehidden' | |||
epub_tocscope = "includehidden" |
Check warning
Code scanning / Pylint (reported by Codacy)
Constant name "epub_tocscope" doesn't conform to UPPER_CASE naming style Warning documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cppcheck (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).method>dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).method dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).class dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).function dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).function>dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected selector "dl.simple dt" to come before selector "html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple).attribute dt" (no-descending-specificity) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { | |||
border-bottom: 1px solid var(--hr-color); |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected indentation of 2 spaces (indentation) Warning documentation
@@ -592,6 +592,11 @@ | |||
background: var(--highlight-background-color); | |||
} | |||
|
|||
dl.simple dt { | |||
border-bottom: 1px solid var(--hr-color); | |||
background: none !important; |
Check warning
Code scanning / Stylelint (reported by Codacy)
Expected indentation of 2 spaces (indentation) Warning documentation
User does event polling instead of an internal vector
Documentation visual quality improvement with category dropdowns
Animation struct for more control over how animations are rendered
getTicks now works
Documentation for contributing has been created
Kraken handles window closing and controller connected/disconnected events
Basically the input namespace got scattered
requirements.txt for necessary pip packages to contribute