gf180mcu-pdk icon indicating copy to clipboard operation
gf180mcu-pdk copied to clipboard

Adding naming documentation

Open mohanad0mohamed opened this issue 3 years ago • 8 comments

Fixes #22

  • Edited conf.py for configuration of colors

  • Edited index.rst to include naming.rst

  • Added naming.rst with info on naming convention.

  • Added extra.css for coloring visuals

  • [x] Built locally with no errors

mohanad0mohamed avatar Jul 26 '22 08:07 mohanad0mohamed

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

mohanad0mohamed avatar Jul 26 '22 08:07 mohanad0mohamed

naming.rst is removed and index.rst is the default with no edits.

mohanad0mohamed avatar Jul 26 '22 08:07 mohanad0mohamed

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.

mithro avatar Jul 26 '22 17:07 mithro

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.

mohanad0mohamed avatar Jul 28 '22 13:07 mohanad0mohamed

I have rebased this change on top of the other work which has been merged. Will add a review shortly.

mithro avatar Aug 03 '22 00:08 mithro

@mohanad0mohamed - I'm not sure the title of this pull request doesn't make sense any more?

mithro avatar Aug 03 '22 00:08 mithro

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.

mohanad0mohamed avatar Aug 03 '22 19:08 mohanad0mohamed

@mithro I have fixed the name as requested from ext.py to sphinx_pdk_roles.py

mohanad0mohamed avatar Aug 08 '22 09:08 mohanad0mohamed