-
Notifications
You must be signed in to change notification settings - Fork 54
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
Adding naming documentation #39
base: main
Are you sure you want to change the base?
Conversation
I have found that the last commit on main branch already contains symbolic link to open-source-pdks which contains |
|
We should move the |
I'm afraid that may not happen, at least for |
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.
I approve this change per @mithro request to clean up the documentation.
I have rebased this change on top of the other work which has been merged. Will add a review shortly. |
@mohanad0mohamed - I'm not sure the title of this pull request doesn't make sense any more? |
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.
Do you think my suggestions here make sense?
docs/conf.py
Outdated
@@ -181,5 +181,94 @@ | |||
[author], 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.
We should move this python code into a sphinx extension module.
We can then add the extension to the requirements.txt
and the extension list found at https://github.com/google/gf180mcu-pdk/blob/main/docs/conf.py#L51-L62
We can probably store the extension in the repository at https://github.com/google/open-source-pdks
57b06ff
to
7361981
Compare
I have edit the required files to depend on |
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 pull request looks really good!
Just one minor comment which is actually about google/open-source-pdks#18
docs/conf.py
Outdated
@@ -59,6 +60,7 @@ | |||
'sphinx.ext.mathjax', | |||
'sphinx.ext.napoleon', | |||
'sphinx.ext.todo', | |||
'ext' |
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.
We should give this extension a better 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.
@mithro I have fixed the name as requested from |
Fixes #22
Edited
conf.py
for configuration of colorsEdited
index.rst
to includenaming.rst
Added
naming.rst
with info on naming convention.Added
extra.css
for coloring visualsBuilt locally with no errors