umarcor
commented
2 years ago @michael-etzkorn you are correct about the naming, pip, etc. I did not change that on purpose. Let me explain:
- Since we did not get any feedback from @kevinpt (yet), we might need to create new namespaces in PyPI for both hdlparse and symbolator, because I don't think we can take over his management.
- I personally like the Symbolator name, so I would not want to change it, unless we are really forced to.
- With regard to hdlparse, there are some other partially related projects which have some naming consistency (vhdl/pyVHDLModel, Paebbels/pyVHDLParser, edaa-org/pySystemVerilogModel, edaa-org/pyEDAA.ProjectModel, etc. (see edaa-org.github.io). It felt to me that hdl/hdlparse might be confusing, so I decided to rename this repo to hdl/pyHDLParser.
- We might decide to release pyEDAA.Symbolator and pyEDAA.pyHDLParser in PyPI, so we can reuse the namespace in pip, even though we keep the repos in different orgs.
- For now, I assume we will be manually cloning the repos and using PYTHONPATH or installing the repo. Therefore, I preserved hdlparse in the codebase to avoid breaking the integration between Symbolator and hdlparse|pyHDLParser. If we decide to rename the Python module from hdlparse to pyVHDLParser (which I do agree with), that needs to be done through two sibling PRs: one here and one in hdl/symbolator.
Paebbels
This PR adds a CI workflow for building the docs and pushing to gh-pages automatically, using the BuildTheDocs Action and theme.