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

Sphinx docs #1

Merged
merged 24 commits into from
Feb 1, 2024
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
838feed
Documentation set up with Sphinx
melissawm Jan 24, 2024
98bcfda
Fix ruff CI warnings
GenevieveBuckley Jan 25, 2024
c39754e
Add 'doc' setup requirements to development install
GenevieveBuckley Jan 25, 2024
e5425cd
Add unlinked documentation file to ToC
GenevieveBuckley Jan 25, 2024
4ef598c
Add video scraper for example animation gallery
GenevieveBuckley Jan 25, 2024
2e73dfa
Reformat docs/conf.py file with black
GenevieveBuckley Jan 25, 2024
707f3f8
Fix ruff formatting warning
GenevieveBuckley Jan 25, 2024
5efe40f
Sphinx docs build producing warning where .mov files exist, we'll use…
GenevieveBuckley Jan 25, 2024
1843ede
Make output video filenames match name of script that generated it
GenevieveBuckley Jan 25, 2024
1084327
More meaningful name for layer_plane_example.py
GenevieveBuckley Jan 25, 2024
02f6470
Shorter name for layer planes example, fits better in gallery thumbnail
GenevieveBuckley Jan 25, 2024
84993ba
Add outside link to main napari.org code of conduct page
GenevieveBuckley Jan 25, 2024
9109682
Minor text update
GenevieveBuckley Jan 25, 2024
58b8ec3
Include README in index and address review comments
melissawm Jan 26, 2024
a4414a3
Fix reference in README
melissawm Jan 26, 2024
c9b119d
Add docs build & deploy script, based on napari/docs github actions s…
GenevieveBuckley Jan 31, 2024
e13f116
Fix HTML formatting of warning/important/note textboxes (breaks githu…
GenevieveBuckley Jan 31, 2024
5560529
Have only one top level heading on docs homepage
GenevieveBuckley Jan 31, 2024
f2750bd
No link checking is actually being performed, remove cruft
GenevieveBuckley Jan 31, 2024
d422921
No github hyperlinks are actually being modified, remove this un-used…
GenevieveBuckley Jan 31, 2024
2f3a575
Allow fallback from VideoScraper to static napari screenshot scraper …
GenevieveBuckley Jan 31, 2024
16f5ce3
Update dependencies
GenevieveBuckley Jan 31, 2024
7824db7
Try github actions permission write contents in yaml script, avoids n…
GenevieveBuckley Feb 1, 2024
bca8791
Merge branch 'main' into sphinx-docs, fixes tox test collection error.
GenevieveBuckley Feb 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add 'doc' setup requirements to development install
GenevieveBuckley committed Jan 25, 2024
commit c39754eba98e06632759b946d07322ea8a6cd181
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# requirements are in setup.cfg
# https://caremad.io/posts/2013/07/setup-vs-requirement/

-e ".[dev]"
-e ".[dev,doc]"