gf180mcu-pdk
gf180mcu-pdk copied to clipboard
Adding naming documentation
Fixes #22
-
Edited
conf.pyfor configuration of colors -
Edited
index.rstto includenaming.rst -
Added
naming.rstwith info on naming convention. -
Added
extra.cssfor coloring visuals -
[x] Built locally with no errors
I have found that the last commit on main branch already contains symbolic link to open-source-pdks which contains naming.rst also. But still we will need the changes in:
conf.py
extra.css
naming.rst is removed and index.rst is the default with no edits.
We should move the extra.css and the python stuff in conf.py into https://github.com/google/open-source-pdks and then this repository should then just use the files from third_party/open-source-pdks like it does with the rst files.
I'm afraid that may not happen, at least for conf.py, as it's used by read-the-docs/sphinx to configure the docs build. The problem is each project may use options different than the other like color scheme, link to their repository, and extensions.
The extra.css can be moved no problems with it.
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?
I have edit the required files to depend on open-source-pdks
This PR https://github.com/google/open-source-pdks/pull/18 should be merged first to take effect.
@mithro I have fixed the name as requested from ext.py to sphinx_pdk_roles.py