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

Code Snippets Docs #124

Closed
ryanhill1 opened this issue Jan 10, 2023 · 0 comments
Closed

Code Snippets Docs #124

ryanhill1 opened this issue Jan 10, 2023 · 0 comments
Assignees
Labels
documentation 📕 Improvements or additions to documentation

Comments

@ryanhill1
Copy link
Member

We want to add a Code Snippets section to the Lab User Guide portion of our docs page. On this page, we want to give an overview of how to use the code snippets extension and show off all of its cool features. Relevant topics include:

  • What are code snippets / what are they for
  • How to copy and use code snippets in my notebooks
  • How to create and edit code snippets
  • How to browse code snippets and search for specific ones
  • Previewing / favoriting / tagging code snippets etc.

See the README for how to develop / build the docs.

The code-snippets-docs branch already includes a file docs/lab/codesnippets.rst that you can work from. So after cloning the repo, run

git switch code-snippets-docs

to make sure you are developing on the correct branch.

If you're unfamiliar with writing using sphinx / RST, there are lots of good resources online including reStructuredText Primer. You can also just copy and modify code from other files in the repo to add links, pictures, style, etc.

@ryanhill1 ryanhill1 added the documentation 📕 Improvements or additions to documentation label Jan 10, 2023
@ryanhill1 ryanhill1 self-assigned this Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📕 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant