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.

Sign up for GitHub

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

Jump to bottom

Add a clearer link to the readthedocs documentation #24

Closed
mithro opened this issue Jun 22, 2020 · 2 comments · Fixed by #29
Closed

Add a clearer link to the readthedocs documentation #24

mithro opened this issue Jun 22, 2020 · 2 comments · Fixed by #29
Assignees
@daniellimws

Comments

@mithro
Copy link
Member

mithro commented Jun 22, 2020 •
edited

Currently the only link to the readthedocs documentation / examples is the tiny little docs badge
(image).

We should make a lot more prominent / clear link.
@mithro
Copy link
Member Author

mithro commented Jun 22, 2020

FYI - It took me a couple of seconds to figure out how to get to the documentation from the github repo and I knew that the docs existed...

@daniellimws
Copy link
Contributor

Could you add the link in the description/about section of the repository?

@daniellimws daniellimws mentioned this issue Jun 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@daniellimws daniellimws

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README information daniellimws/sphinxcontrib-verilog-diagrams
2 participants
@mithro @daniellimws