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

Adding a way to display the license for the documentation at the bottom of the page #30

Closed
mithro opened this issue Jul 21, 2020 · 9 comments · Fixed by #36
Closed

Adding a way to display the license for the documentation at the bottom of the page #30

mithro opened this issue Jul 21, 2020 · 9 comments · Fixed by #36
Assignees

Comments

@mithro
Copy link
Member

mithro commented Jul 21, 2020

@mguthaus makes a good point in google/skywater-pdk#118 that we should display the license the documentation is at.

This should probably be a set of settings under html_theme_options;

@mithro
Copy link
Member Author

mithro commented Jul 21, 2020

Also see https://gist.github.com/qvil/5e3ed56c26d784e51424621119cc4028

Gist
License Badges for your Project. GitHub Gist: instantly share code, notes, and snippets.

@mithro
Copy link
Member Author

mithro commented Jul 21, 2020

@daniellimws Any chance you could look at this?

@mithro
Copy link
Member Author

mithro commented Jul 21, 2020

It should be noted that the license for the documentation might not be the same as the license for the code repo.

@daniellimws
Copy link
Collaborator

@mithro I feel that a plain "License" string looks nicer than having the badge in the footer. What do you think?

image

image

@mithro
Copy link
Member Author

mithro commented Aug 14, 2020

I do think the non-badge format fits nicer /but/ I do like the badge has the actual license name in it.....

@daniellimws
Copy link
Collaborator

How about putting the license name in parenthesis, like License (ISC)? Or shall I change it to show the badge?

@mithro
Copy link
Member Author

mithro commented Aug 14, 2020

Putting the license name in parenthesis seems like an option.

@daniellimws
Copy link
Collaborator

We could query for the repository's license through the GitHub api, so the user would have less things to configure in conf.py, but that would require additional javascript.

@mithro What do you think, because of #4?

@mithro
Copy link
Member Author

mithro commented Aug 22, 2020

@daniellimws I would just make the user set it.

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 a pull request may close this issue.

2 participants