Skip to content
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

docs: update pip install to use sphinxcontrib-verilog-diagrams #92

Closed
wants to merge 1 commit into from

Conversation

oharboe
Copy link
Contributor

@oharboe oharboe commented Sep 21, 2023

I'm unsure why the pip module is called sphinxcontrib-verilog-diagrams and elsewhere sphinx_hdl_diagrams is used. Historical resasons?

Anyway, now docs match what I find on pypi:

image

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
@mithro
Copy link
Member

mithro commented Sep 21, 2023

Yes, the module was originally only able to handle verilog code, but then some people improved it to support vhdl and other things that Yosys can parse.

@mithro
Copy link
Member

mithro commented Sep 21, 2023

We should probably create a "dummy" sphinxcontrib-verilog-diagrams module which just redirects everything to sphinxcontrib-hdl-diagrams?

@mithro
Copy link
Member

mithro commented Sep 21, 2023

I'll also upload the module to PyPi as sphinxcontrib-hdl-diagrams

@mithro
Copy link
Member

mithro commented Sep 21, 2023

#93

@oharboe
Copy link
Contributor Author

oharboe commented Sep 21, 2023

@mithro I'm trusting your judgement here :-) I saw something that I thought was a simple search and replace fix...

Close this PR?

@mithro
Copy link
Member

mithro commented Sep 21, 2023

Yes, closing the pull request.

Also logged #94

@mithro mithro closed this Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants