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

[DOC] Add instructions on how to write a gallery example #335

Open
mbeyeler opened this issue Dec 9, 2020 · 0 comments
Open

[DOC] Add instructions on how to write a gallery example #335

mbeyeler opened this issue Dec 9, 2020 · 0 comments
Labels
doc
Milestone
v0.11

Comments

@mbeyeler
Copy link
Member

mbeyeler commented Dec 9, 2020

  • create file in the right subdirectory (e.g., pulse2percept/examples/stimuli)
  • filename must start with "plot_" (e.g. plot_grating_stim.py)
  • generate docs locally: make doc from root
  • verify docs locally: open doc/_build/html/index.html in a web browser
@mbeyeler mbeyeler added the doc label Dec 9, 2020
@mbeyeler mbeyeler added this to the v0.8 milestone Jan 26, 2021
@mbeyeler mbeyeler modified the milestones: v0.8, v0.9 Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
v0.11
Development

No branches or pull requests
1 participant
@mbeyeler