-
Notifications
You must be signed in to change notification settings - Fork 2
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
Sphinx doc #23
base: master
Are you sure you want to change the base?
Sphinx doc #23
Conversation
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
CI/doc/source/conf.py
Outdated
author = "Analog Devices, Inc." | ||
|
||
# The full version, including alpha/beta/rc tags | ||
release = "v22.2.1" |
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.
This should probably reflect what its tested against
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.
Fixed.
CI/doc/source/conf.py
Outdated
# -- Project information ----------------------------------------------------- | ||
|
||
project = "Analog Devices, Inc. Transceiver Toolbox" | ||
copyright = "2019-2022, Analog Devices, Inc" |
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.
Update to current year
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.
Fixed
CI/doc/source/conf.py
Outdated
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = "Analog Devices, Inc. Transceiver Toolbox" |
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.
Update name
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.
Fixed
if not os.path.exists(p): | ||
os.mkdir("_static/logos") | ||
|
||
for filename in os.listdir(os.path.join("..", "..", "..", "logos")): |
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.
This assumes logo files are in a logo directory at the root of the directory. This should be removed or the logo files put in that folder
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.
A folder called logos exists in the branch.
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.
Remove
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.
Removed
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.
Remove
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.
Removed
CI/doc/source/_static/assets/HWA.png
Outdated
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.
Remove
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.
Removed
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.
Remove
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.
Removed
CI/doc/source/examples.md
Outdated
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.
Remove
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.
Done
CI/doc/source/objects.md
Outdated
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.
Is this auto generated?
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.
Removed.
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
Signed-off-by: spagadar <[email protected]>
No description provided.