Skip to content

Commit

Permalink
Merge branch 'main' into improve-makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
melissawm committed Dec 13, 2022
2 parents 9fab46b + e634704 commit 5bd865a
Show file tree
Hide file tree
Showing 17 changed files with 433 additions and 243 deletions.
19 changes: 4 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,29 +1,18 @@
---
name: "\U0001F41B Bug Report"
about: Submit a bug report to help us improve napari
about: Report typos, innacuracies or errors to help us improve the napari documentation
title: ''
labels: bug
assignees: ''

---

## 🐛 Bug

<!-- A clear and concise description of what the bug is. -->

## To Reproduce

Steps to reproduce the behavior:

1.
2.
3.

<!-- A clear and concise description of what the issue is. -->
<!-- Please provide the URL(s) of the page(s) that are problematic. -->
<!-- If you can, please add a screenshot or screen capture: "An image is worth a thousand words!" -->
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## Environment

Expand Down
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -1,6 +1,14 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true # default
contact_links:
- name: 👩🏽‍💻 main napari repository
url: https://github.com/napari/napari
about: |
If your issue requires a docstring update, or changes to the examples gallery, please check the main napari repo.
- name: ✨ napari-sphinx-theme
url: https://github.com/napari/napari-sphinx-theme
about: |
If your issue is about the napari.org website design or functionality, please check the napari-sphinx-theme repo.
- name: 🤷💻 napari forum
url: https://forum.image.sc/tag/napari
about: |
Expand Down
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/design_related.md

This file was deleted.

11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/new_content.md
@@ -0,0 +1,15 @@
---
name: "\U0001F4DA New content request"
about: Suggest new content pages to be added to the napari documentation
title: ''
labels: content
assignees: ''

---

## 📚 New content request
<!-- A clear and concise description of the content you'd like to see, and why this is important -->


### Outline
<!-- Please include a rough outline of the document you are proposing -->
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/task.md
@@ -1,11 +1,10 @@
---
name: "\U0001F9F0 Task"
about: Submit a proposal/request for a new napari feature
about: Submit a proposal/request for improvements to workflows, documentation build or deployment.
title: ''
labels: task
assignees: ''

---

## 🧰 Task
<!-- A clear and concise description of the task -->
23 changes: 7 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,29 +1,20 @@
# Description
<!-- What does this pull request (PR) do? Why is it necessary? -->
<!-- Tell us about your new feature, improvement, or fix! -->
<!-- If your change includes user interface changes, please add an image, or an animation "An image is worth a thousand words!" -->
<!-- Tell us about your new content, improvement, or fix! -->
<!-- If you can, please add an image, or an animation "An image is worth a thousand words!" -->
<!-- You can use https://www.cockos.com/licecap/ or similar to create animations -->

## Type of change
<!-- Please delete options that are not relevant. -->
- [ ] Bug-fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Fixes or improves existing content
- [ ] Adds new content page(s)
- [ ] Fixes or improves workflow, documentation build or deployment

# References
<!-- What resources, documentation, and guides were used in the creation of this PR? -->
<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->

# How has this been tested?
<!-- Please describe the tests that you ran to verify your changes. -->
- [ ] example: the test suite for my feature covers cases x, y, and z
- [ ] example: all tests pass with my change
<!-- If this is a fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->

## Final checklist:
- [ ] My PR is the minimum possible work for the desired functionality
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] If I included new strings, I have used `trans.` to make them localizable.
For more information see our [translations guide](https://napari.org/docs/dev/guides/translations.html).
- [ ] I have added [alt text](https://webaim.org/techniques/alttext/) to new images included in this PR
2 changes: 1 addition & 1 deletion README.md
@@ -1,6 +1,6 @@
# napari docs

This repository contains the sources for the napari documentation. This includes tutorials, how-tos, the examples gallery and the autogenerated API documentation extracted from the source code docstrings.
This repository contains the sources for the napari documentation. This includes tutorials, how-tos and other narrative documentation. The autogenerated API documentation is extracted from the source code docstrings, which live on https://github.com/napari/napari

## mission, values, and roadmap

Expand Down
1 change: 1 addition & 0 deletions docs/_toc.yml
Expand Up @@ -34,6 +34,7 @@ subtrees:
- entries:
- file: tutorials/tracking/cell_tracking
- file: further-resources/napari-workshops
- file: further-resources/sample_data
- file: howtos/index
subtrees:
- titlesonly: True
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
Expand Up @@ -144,8 +144,8 @@
'https://napari-plugin-engine.readthedocs.io/en/latest/objects.inv',
],
'magicgui': [
'https://napari.org/magicgui/',
'https://napari.org/magicgui/objects.inv',
'https://pyapp-kit.github.io/magicgui/',
'https://pyapp-kit.github.io/magicgui/objects.inv',
],
}

Expand Down Expand Up @@ -189,9 +189,9 @@ def reset_napari_theme(gallery_conf, fname):
settings.appearance.theme = 'dark'
qtgallery.reset_qapp(gallery_conf, fname)


sphinx_gallery_conf = {
'examples_dirs': '../examples', # path to your example scripts
#'examples_dirs': '../../napari/examples', # path to your example scripts
# this value is set in the Makefile
'gallery_dirs': 'gallery', # path to where to save gallery generated output
'filename_pattern': '/*.py',
'ignore_pattern': 'README.rst|/*_.py',
Expand Down

0 comments on commit 5bd865a

Please sign in to comment.