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

Add copy buttons to documentation #341

Closed
amageh opened this issue Jun 1, 2022 · 2 comments
Closed

Add copy buttons to documentation #341

amageh opened this issue Jun 1, 2022 · 2 comments
Assignees
Labels
docs Documentation improvements enhancement New feature or request

Comments

@amageh
Copy link
Collaborator

amageh commented Jun 1, 2022

What would you like to enhance and why?

I think it would be nice to add copy buttons like this to the documentation so it is easier to copy code snippets etc.

I would add them to:

Anyone feel free to add points in the documentation where this makes sense, I will open a PR to implement it.

@amageh amageh added enhancement New feature or request docs Documentation improvements labels Jun 1, 2022
@amageh amageh self-assigned this Jun 1, 2022
@janosg
Copy link
Member

janosg commented Jun 1, 2022

Thanks, Annica! This is a great idea.

For installation we should add a copy button once at the main installation instruction but then also for each optimizer that requires an optional dependency.

Additional places:

  • The command to start the dashboard
  • Self contained examples on how to use constraints that can then be adjusted by users

@janosg
Copy link
Member

janosg commented Sep 30, 2022

Outdated.

@janosg janosg closed this as completed Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants