diff --git a/.circleci/config.yml b/.circleci/config.yml index f808dcd58..d1a49e4e4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -44,11 +44,11 @@ jobs: environment: PIP_CONSTRAINT: ../napari/resources/constraints/constraints_py3.10_docs.txt - store_artifacts: - path: docs/docs/_build/html/ + path: docs/_build/html/ - persist_to_workspace: root: . paths: - - docs/docs/_build/html/ + - docs/_build/html/ workflows: build-docs: jobs: diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml index 0a24fecd6..9a67e6208 100644 --- a/.github/workflows/build_and_deploy.yml +++ b/.github/workflows/build_and_deploy.yml @@ -89,7 +89,7 @@ jobs: uses: actions/upload-artifact@v4 with: name: html - path: docs/docs/_build/html/ + path: docs/_build/html/ deploy: name: Download & Deploy Artifact diff --git a/.github/workflows/circleci.yml b/.github/workflows/circleci.yml index bf865e446..a16fdb7bf 100644 --- a/.github/workflows/circleci.yml +++ b/.github/workflows/circleci.yml @@ -19,6 +19,6 @@ jobs: with: repo-token: ${{ secrets.GITHUB_TOKEN }} api-token: ${{ secrets.CIRCLECI_TOKEN }} - artifact-path: 0/docs/docs/_build/html/index.html + artifact-path: 0/docs/_build/html/index.html circleci-jobs: build-docs job-title: Check the rendered docs here! diff --git a/.gitignore b/.gitignore index e78038cb2..dd36af9a4 100644 --- a/.gitignore +++ b/.gitignore @@ -139,7 +139,7 @@ napari/view_layers.pyi napari/components/viewer_model.pyi # Sphinx documentation -docs/_build +_build docs/_tags/ docs/api/napari* docs/gallery/ @@ -148,8 +148,8 @@ docs/guides/_layer_events.md docs/guides/_layerlist_events.md docs/guides/_viewer_events.md docs/images/_autogenerated/ -docs/jupyter_execute/ docs/sg_execution_times.rst +jupyter_execute # come from npe2 docs docs/plugins/_npe2_*.md diff --git a/Makefile b/Makefile index 111a436cf..966d888d9 100644 --- a/Makefile +++ b/Makefile @@ -15,7 +15,7 @@ docs_dir := $(current_dir)docs clean: echo clean echo $(current_dir) - rm -rf $(docs_dir)/_build/ + rm -rf _build/ rm -rf $(docs_dir)/api/napari*.rst rm -rf $(docs_dir)/gallery/* rm -rf $(docs_dir)/_tags @@ -27,11 +27,27 @@ docs-install: prep-docs: python $(docs_dir)/_scripts/prep_docs.py +organize-docs: + mv _build/unversioned/html/*.html _build/html/ + mv _build/unversioned/html/developers _build/html/ + mv _build/unversioned/html/naps _build/html/ + mv _build/unversioned/html/release _build/html/ + mv _build/unversioned/html/roadmaps _build/html/ + mv _build/unversioned/html/objects.inv _build/html/dev_objects.inv + docs-build: prep-docs - NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ docs/_build -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ _build -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + mv _build/html/objects.inv _build/napari_objects.inv + NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html unversioned/ _build/unversioned $(SPHINXOPTS) + mv _build/napari_objects.inv _build/html/objects.inv + $(MAKE) organize-docs docs-xvfb: prep-docs - NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 xvfb-run --auto-servernum sphinx-build -M html docs/ docs/_build -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 xvfb-run --auto-servernum sphinx-build -M html docs/ _build -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + mv _build/html/objects.inv _build/napari_objects.inv + NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 xvfb-run --auto-servernum sphinx-build -M html unversioned/ _build/unversioned $(SPHINXOPTS) + mv _build/napari_objects.inv _build/html/objects.inv + $(MAKE) organize-docs docs: clean docs-install docs-build @@ -39,6 +55,7 @@ html: clean docs-build # Implies noplot, but no clean - call 'make clean' manually if needed # Autogenerated paths need to be ignored to prevent reload loops +# TODO: Fix this to work with two folders html-live: prep-docs NAPARI_APPLICATION_IPY_INTERACTIVE=0 \ sphinx-autobuild \ @@ -56,13 +73,18 @@ html-live: prep-docs $(SPHINXOPTS) html-noplot: clean prep-docs - NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ docs/_build -D plot_gallery=0 -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ _build -D plot_gallery=0 -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + mv _build/html/objects.inv _build/napari_objects.inv + NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html unversioned/ _build $(SPHINXOPTS) + mv _build/napari_objects.inv _build/html/objects.inv + $(MAKE) organize-docs linkcheck-files: - NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b linkcheck -D plot_gallery=0 --color docs/ docs/_build ${FILES} -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b linkcheck -D plot_gallery=0 --color docs/ _build/html ${FILES} -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS) + NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b linkcheck --color unversioned/ _build/unversioned/html ${FILES} $(SPHINXOPTS) fallback-videos: - for video in $(basename $(wildcard docs/_static/images/*.webm)); do \ + for video in $(basename $(wildcard _static/images/*.webm)); do \ if [ -a $$video.mp4 ]; then \ echo "skipping $$video.mp4"; \ continue; \ @@ -71,4 +93,4 @@ fallback-videos: done fallback-videos-clean: - rm -f docs/_static/images/*.mp4 + rm -f _static/images/*.mp4 diff --git a/docs/_static/announcement.html b/_static/announcement.html similarity index 100% rename from docs/_static/announcement.html rename to _static/announcement.html diff --git a/docs/_static/custom.css b/_static/custom.css similarity index 100% rename from docs/_static/custom.css rename to _static/custom.css diff --git a/docs/_static/favicon/logo-noborder-180.png b/_static/favicon/logo-noborder-180.png similarity index 100% rename from docs/_static/favicon/logo-noborder-180.png rename to _static/favicon/logo-noborder-180.png diff --git a/docs/_static/favicon/logo-silhouette-192.png b/_static/favicon/logo-silhouette-192.png similarity index 100% rename from docs/_static/favicon/logo-silhouette-192.png rename to _static/favicon/logo-silhouette-192.png diff --git a/docs/_static/favicon/logo-silhouette-dark-light.svg b/_static/favicon/logo-silhouette-dark-light.svg similarity index 100% rename from docs/_static/favicon/logo-silhouette-dark-light.svg rename to _static/favicon/logo-silhouette-dark-light.svg diff --git a/docs/images/2D-button.png b/_static/images/2D-button.png similarity index 100% rename from docs/images/2D-button.png rename to _static/images/2D-button.png diff --git a/docs/images/3D-button.png b/_static/images/3D-button.png similarity index 100% rename from docs/images/3D-button.png rename to _static/images/3D-button.png diff --git a/docs/images/3D_paths.png b/_static/images/3D_paths.png similarity index 100% rename from docs/images/3D_paths.png rename to _static/images/3D_paths.png diff --git a/docs/images/IPython.png b/_static/images/IPython.png similarity index 100% rename from docs/images/IPython.png rename to _static/images/IPython.png diff --git a/docs/_static/images/LLSM.png b/_static/images/LLSM.png similarity index 100% rename from docs/_static/images/LLSM.png rename to _static/images/LLSM.png diff --git a/docs/_static/images/LLSM.webm b/_static/images/LLSM.webm similarity index 100% rename from docs/_static/images/LLSM.webm rename to _static/images/LLSM.webm diff --git a/docs/images/add_vectors_image.png b/_static/images/add_vectors_image.png similarity index 100% rename from docs/images/add_vectors_image.png rename to _static/images/add_vectors_image.png diff --git a/docs/_static/images/brain_surface.png b/_static/images/brain_surface.png similarity index 100% rename from docs/_static/images/brain_surface.png rename to _static/images/brain_surface.png diff --git a/docs/_static/images/brain_surface.webm b/_static/images/brain_surface.webm similarity index 100% rename from docs/_static/images/brain_surface.webm rename to _static/images/brain_surface.webm diff --git a/docs/images/coverage_report.png b/_static/images/coverage_report.png similarity index 100% rename from docs/images/coverage_report.png rename to _static/images/coverage_report.png diff --git a/docs/_static/images/dask1.png b/_static/images/dask1.png similarity index 100% rename from docs/_static/images/dask1.png rename to _static/images/dask1.png diff --git a/docs/_static/images/dask1.webm b/_static/images/dask1.webm similarity index 100% rename from docs/_static/images/dask1.webm rename to _static/images/dask1.webm diff --git a/docs/_static/images/dask2.png b/_static/images/dask2.png similarity index 100% rename from docs/_static/images/dask2.png rename to _static/images/dask2.png diff --git a/docs/_static/images/dask2.webm b/_static/images/dask2.webm similarity index 100% rename from docs/_static/images/dask2.webm rename to _static/images/dask2.webm diff --git a/docs/_static/images/delete_label.png b/_static/images/delete_label.png similarity index 100% rename from docs/_static/images/delete_label.png rename to _static/images/delete_label.png diff --git a/docs/_static/images/delete_label.webm b/_static/images/delete_label.webm similarity index 100% rename from docs/_static/images/delete_label.webm rename to _static/images/delete_label.webm diff --git a/docs/_static/images/draw_component.png b/_static/images/draw_component.png similarity index 100% rename from docs/_static/images/draw_component.png rename to _static/images/draw_component.png diff --git a/docs/_static/images/draw_component.webm b/_static/images/draw_component.webm similarity index 100% rename from docs/_static/images/draw_component.webm rename to _static/images/draw_component.webm diff --git a/docs/images/edit_token_permissions.png b/_static/images/edit_token_permissions.png similarity index 100% rename from docs/images/edit_token_permissions.png rename to _static/images/edit_token_permissions.png diff --git a/docs/_static/images/editing_points.png b/_static/images/editing_points.png similarity index 100% rename from docs/_static/images/editing_points.png rename to _static/images/editing_points.png diff --git a/docs/_static/images/editing_points.webm b/_static/images/editing_points.webm similarity index 100% rename from docs/_static/images/editing_points.webm rename to _static/images/editing_points.webm diff --git a/docs/_static/images/editing_shapes.png b/_static/images/editing_shapes.png similarity index 100% rename from docs/_static/images/editing_shapes.png rename to _static/images/editing_shapes.png diff --git a/docs/_static/images/editing_shapes.webm b/_static/images/editing_shapes.webm similarity index 100% rename from docs/_static/images/editing_shapes.webm rename to _static/images/editing_shapes.webm diff --git a/docs/images/fine_grained_token.png b/_static/images/fine_grained_token.png similarity index 100% rename from docs/images/fine_grained_token.png rename to _static/images/fine_grained_token.png diff --git a/docs/images/labels-layer-eraser.png b/_static/images/labels-layer-eraser.png similarity index 100% rename from docs/images/labels-layer-eraser.png rename to _static/images/labels-layer-eraser.png diff --git a/docs/images/lines_not_run_highlighted_in_red.png b/_static/images/lines_not_run_highlighted_in_red.png similarity index 100% rename from docs/images/lines_not_run_highlighted_in_red.png rename to _static/images/lines_not_run_highlighted_in_red.png diff --git a/docs/images/logo.png b/_static/images/logo.png similarity index 100% rename from docs/images/logo.png rename to _static/images/logo.png diff --git a/docs/_static/images/manual_label.png b/_static/images/manual_label.png similarity index 100% rename from docs/_static/images/manual_label.png rename to _static/images/manual_label.png diff --git a/docs/_static/images/manual_label.webm b/_static/images/manual_label.webm similarity index 100% rename from docs/_static/images/manual_label.webm rename to _static/images/manual_label.webm diff --git a/docs/_static/images/merge_labels.png b/_static/images/merge_labels.png similarity index 100% rename from docs/_static/images/merge_labels.png rename to _static/images/merge_labels.png diff --git a/docs/_static/images/merge_labels.webm b/_static/images/merge_labels.webm similarity index 100% rename from docs/_static/images/merge_labels.webm rename to _static/images/merge_labels.webm diff --git a/docs/_static/images/mitosis.png b/_static/images/mitosis.png similarity index 100% rename from docs/_static/images/mitosis.png rename to _static/images/mitosis.png diff --git a/docs/_static/images/mitosis.webm b/_static/images/mitosis.webm similarity index 100% rename from docs/_static/images/mitosis.webm rename to _static/images/mitosis.webm diff --git a/docs/_static/images/nD_shapes.png b/_static/images/nD_shapes.png similarity index 100% rename from docs/_static/images/nD_shapes.png rename to _static/images/nD_shapes.png diff --git a/docs/_static/images/nD_shapes.webm b/_static/images/nD_shapes.webm similarity index 100% rename from docs/_static/images/nD_shapes.webm rename to _static/images/nD_shapes.webm diff --git a/docs/_static/images/nD_vectors.png b/_static/images/nD_vectors.png similarity index 100% rename from docs/_static/images/nD_vectors.png rename to _static/images/nD_vectors.png diff --git a/docs/_static/images/nD_vectors.webm b/_static/images/nD_vectors.webm similarity index 100% rename from docs/_static/images/nD_vectors.webm rename to _static/images/nD_vectors.webm diff --git a/docs/images/napari-logo-3-with-guides.png b/_static/images/napari-logo-3-with-guides.png similarity index 100% rename from docs/images/napari-logo-3-with-guides.png rename to _static/images/napari-logo-3-with-guides.png diff --git a/docs/images/napari-logo-3.png b/_static/images/napari-logo-3.png similarity index 100% rename from docs/images/napari-logo-3.png rename to _static/images/napari-logo-3.png diff --git a/docs/images/napari-logo-old-new.png b/_static/images/napari-logo-old-new.png similarity index 100% rename from docs/images/napari-logo-old-new.png rename to _static/images/napari-logo-old-new.png diff --git a/docs/images/napari_plugins_1st_napari_get_reader.png b/_static/images/napari_plugins_1st_napari_get_reader.png similarity index 100% rename from docs/images/napari_plugins_1st_napari_get_reader.png rename to _static/images/napari_plugins_1st_napari_get_reader.png diff --git a/docs/images/napari_plugins_2nd_reader_function.png b/_static/images/napari_plugins_2nd_reader_function.png similarity index 100% rename from docs/images/napari_plugins_2nd_reader_function.png rename to _static/images/napari_plugins_2nd_reader_function.png diff --git a/docs/images/napari_plugins_3rd_pytest_passed.png b/_static/images/napari_plugins_3rd_pytest_passed.png similarity index 100% rename from docs/images/napari_plugins_3rd_pytest_passed.png rename to _static/images/napari_plugins_3rd_pytest_passed.png diff --git a/docs/images/napari_plugins_4th_test_get_reader_returns_callable-failed.png b/_static/images/napari_plugins_4th_test_get_reader_returns_callable-failed.png similarity index 100% rename from docs/images/napari_plugins_4th_test_get_reader_returns_callable-failed.png rename to _static/images/napari_plugins_4th_test_get_reader_returns_callable-failed.png diff --git a/docs/images/napari_plugins_5th_tests_passed.png b/_static/images/napari_plugins_5th_tests_passed.png similarity index 100% rename from docs/images/napari_plugins_5th_tests_passed.png rename to _static/images/napari_plugins_5th_tests_passed.png diff --git a/docs/images/ndisplay.png b/_static/images/ndisplay.png similarity index 100% rename from docs/images/ndisplay.png rename to _static/images/ndisplay.png diff --git a/docs/images/pan-zoom-tool.png b/_static/images/pan-zoom-tool.png similarity index 100% rename from docs/images/pan-zoom-tool.png rename to _static/images/pan-zoom-tool.png diff --git a/docs/_static/images/pathology.png b/_static/images/pathology.png similarity index 100% rename from docs/_static/images/pathology.png rename to _static/images/pathology.png diff --git a/docs/_static/images/pathology.webm b/_static/images/pathology.webm similarity index 100% rename from docs/_static/images/pathology.webm rename to _static/images/pathology.webm diff --git a/docs/images/plugin-install-dialog.png b/_static/images/plugin-install-dialog.png similarity index 100% rename from docs/images/plugin-install-dialog.png rename to _static/images/plugin-install-dialog.png diff --git a/docs/images/plugin-menu.png b/_static/images/plugin-menu.png similarity index 100% rename from docs/images/plugin-menu.png rename to _static/images/plugin-menu.png diff --git a/docs/images/point-adding-tool.png b/_static/images/point-adding-tool.png similarity index 100% rename from docs/images/point-adding-tool.png rename to _static/images/point-adding-tool.png diff --git a/docs/images/point-deleting-tool.png b/_static/images/point-deleting-tool.png similarity index 100% rename from docs/images/point-deleting-tool.png rename to _static/images/point-deleting-tool.png diff --git a/docs/images/point-selecting-tool.png b/_static/images/point-selecting-tool.png similarity index 100% rename from docs/images/point-selecting-tool.png rename to _static/images/point-selecting-tool.png diff --git a/docs/_static/images/point_annotator_demo.png b/_static/images/point_annotator_demo.png similarity index 100% rename from docs/_static/images/point_annotator_demo.png rename to _static/images/point_annotator_demo.png diff --git a/docs/_static/images/point_annotator_demo.webm b/_static/images/point_annotator_demo.webm similarity index 100% rename from docs/_static/images/point_annotator_demo.webm rename to _static/images/point_annotator_demo.webm diff --git a/docs/_static/images/scaling.png b/_static/images/scaling.png similarity index 100% rename from docs/_static/images/scaling.png rename to _static/images/scaling.png diff --git a/docs/_static/images/scaling.webm b/_static/images/scaling.webm similarity index 100% rename from docs/_static/images/scaling.webm rename to _static/images/scaling.webm diff --git a/docs/images/screenshot-add-image.png b/_static/images/screenshot-add-image.png similarity index 100% rename from docs/images/screenshot-add-image.png rename to _static/images/screenshot-add-image.png diff --git a/docs/images/second_coverage_report.png b/_static/images/second_coverage_report.png similarity index 100% rename from docs/images/second_coverage_report.png rename to _static/images/second_coverage_report.png diff --git a/docs/images/secrets_section.png b/_static/images/secrets_section.png similarity index 100% rename from docs/images/secrets_section.png rename to _static/images/secrets_section.png diff --git a/docs/images/shape-add-ellipses.png b/_static/images/shape-add-ellipses.png similarity index 100% rename from docs/images/shape-add-ellipses.png rename to _static/images/shape-add-ellipses.png diff --git a/docs/images/shape-add-lasso.png b/_static/images/shape-add-lasso.png similarity index 100% rename from docs/images/shape-add-lasso.png rename to _static/images/shape-add-lasso.png diff --git a/docs/images/shape-add-lines.png b/_static/images/shape-add-lines.png similarity index 100% rename from docs/images/shape-add-lines.png rename to _static/images/shape-add-lines.png diff --git a/docs/images/shape-add-path.png b/_static/images/shape-add-path.png similarity index 100% rename from docs/images/shape-add-path.png rename to _static/images/shape-add-path.png diff --git a/docs/images/shape-add-polygons.png b/_static/images/shape-add-polygons.png similarity index 100% rename from docs/images/shape-add-polygons.png rename to _static/images/shape-add-polygons.png diff --git a/docs/images/shape-add-rectangles.png b/_static/images/shape-add-rectangles.png similarity index 100% rename from docs/images/shape-add-rectangles.png rename to _static/images/shape-add-rectangles.png diff --git a/docs/images/shape-delete-shape.png b/_static/images/shape-delete-shape.png similarity index 100% rename from docs/images/shape-delete-shape.png rename to _static/images/shape-delete-shape.png diff --git a/docs/images/shape-move-to-back.png b/_static/images/shape-move-to-back.png similarity index 100% rename from docs/images/shape-move-to-back.png rename to _static/images/shape-move-to-back.png diff --git a/docs/images/shape-move-to-front.png b/_static/images/shape-move-to-front.png similarity index 100% rename from docs/images/shape-move-to-front.png rename to _static/images/shape-move-to-front.png diff --git a/docs/images/shape-select-shape.png b/_static/images/shape-select-shape.png similarity index 100% rename from docs/images/shape-select-shape.png rename to _static/images/shape-select-shape.png diff --git a/docs/images/shape-vertex-insert.png b/_static/images/shape-vertex-insert.png similarity index 100% rename from docs/images/shape-vertex-insert.png rename to _static/images/shape-vertex-insert.png diff --git a/docs/images/shape-vertices-select.png b/_static/images/shape-vertices-select.png similarity index 100% rename from docs/images/shape-vertices-select.png rename to _static/images/shape-vertices-select.png diff --git a/docs/_static/images/shape_resizing.png b/_static/images/shape_resizing.png similarity index 100% rename from docs/_static/images/shape_resizing.png rename to _static/images/shape_resizing.png diff --git a/docs/_static/images/shape_resizing.webm b/_static/images/shape_resizing.webm similarity index 100% rename from docs/_static/images/shape_resizing.webm rename to _static/images/shape_resizing.webm diff --git a/docs/images/shape_vertex_delete.png b/_static/images/shape_vertex_delete.png similarity index 100% rename from docs/images/shape_vertex_delete.png rename to _static/images/shape_vertex_delete.png diff --git a/docs/_static/images/shape_vertex_editing.png b/_static/images/shape_vertex_editing.png similarity index 100% rename from docs/_static/images/shape_vertex_editing.png rename to _static/images/shape_vertex_editing.png diff --git a/docs/_static/images/shape_vertex_editing.webm b/_static/images/shape_vertex_editing.webm similarity index 100% rename from docs/_static/images/shape_vertex_editing.webm rename to _static/images/shape_vertex_editing.webm diff --git a/docs/_static/images/smFISH.png b/_static/images/smFISH.png similarity index 100% rename from docs/_static/images/smFISH.png rename to _static/images/smFISH.png diff --git a/docs/_static/images/smFISH.webm b/_static/images/smFISH.webm similarity index 100% rename from docs/_static/images/smFISH.webm rename to _static/images/smFISH.webm diff --git a/docs/_static/images/split_label.png b/_static/images/split_label.png similarity index 100% rename from docs/_static/images/split_label.png rename to _static/images/split_label.png diff --git a/docs/_static/images/split_label.webm b/_static/images/split_label.webm similarity index 100% rename from docs/_static/images/split_label.webm rename to _static/images/split_label.webm diff --git a/docs/images/test_coverage_htmlcov_directory.png b/_static/images/test_coverage_htmlcov_directory.png similarity index 100% rename from docs/images/test_coverage_htmlcov_directory.png rename to _static/images/test_coverage_htmlcov_directory.png diff --git a/docs/images/tests.png b/_static/images/tests.png similarity index 100% rename from docs/images/tests.png rename to _static/images/tests.png diff --git a/docs/images/token_permission_form.png b/_static/images/token_permission_form.png similarity index 100% rename from docs/images/token_permission_form.png rename to _static/images/token_permission_form.png diff --git a/docs/images/token_permission_selection.png b/_static/images/token_permission_selection.png similarity index 100% rename from docs/images/token_permission_selection.png rename to _static/images/token_permission_selection.png diff --git a/docs/_static/images/tracks_3d_t.png b/_static/images/tracks_3d_t.png similarity index 100% rename from docs/_static/images/tracks_3d_t.png rename to _static/images/tracks_3d_t.png diff --git a/docs/_static/images/tracks_3d_t.webm b/_static/images/tracks_3d_t.webm similarity index 100% rename from docs/_static/images/tracks_3d_t.webm rename to _static/images/tracks_3d_t.webm diff --git a/docs/_static/images/tracks_color_by.png b/_static/images/tracks_color_by.png similarity index 100% rename from docs/_static/images/tracks_color_by.png rename to _static/images/tracks_color_by.png diff --git a/docs/_static/images/tracks_color_by.webm b/_static/images/tracks_color_by.webm similarity index 100% rename from docs/_static/images/tracks_color_by.webm rename to _static/images/tracks_color_by.webm diff --git a/docs/_static/images/tracks_isbi.png b/_static/images/tracks_isbi.png similarity index 100% rename from docs/_static/images/tracks_isbi.png rename to _static/images/tracks_isbi.png diff --git a/docs/_static/images/tracks_isbi.webm b/_static/images/tracks_isbi.webm similarity index 100% rename from docs/_static/images/tracks_isbi.webm rename to _static/images/tracks_isbi.webm diff --git a/docs/_static/images/tracks_simple_demo.png b/_static/images/tracks_simple_demo.png similarity index 100% rename from docs/_static/images/tracks_simple_demo.png rename to _static/images/tracks_simple_demo.png diff --git a/docs/_static/images/tracks_simple_demo.webm b/_static/images/tracks_simple_demo.webm similarity index 100% rename from docs/_static/images/tracks_simple_demo.webm rename to _static/images/tracks_simple_demo.webm diff --git a/docs/_static/images/tracks_tail_length.png b/_static/images/tracks_tail_length.png similarity index 100% rename from docs/_static/images/tracks_tail_length.png rename to _static/images/tracks_tail_length.png diff --git a/docs/_static/images/tracks_tail_length.webm b/_static/images/tracks_tail_length.webm similarity index 100% rename from docs/_static/images/tracks_tail_length.webm rename to _static/images/tracks_tail_length.webm diff --git a/docs/_static/images/tracks_tail_width.png b/_static/images/tracks_tail_width.png similarity index 100% rename from docs/_static/images/tracks_tail_width.png rename to _static/images/tracks_tail_width.png diff --git a/docs/_static/images/tracks_tail_width.webm b/_static/images/tracks_tail_width.webm similarity index 100% rename from docs/_static/images/tracks_tail_width.webm rename to _static/images/tracks_tail_width.webm diff --git a/docs/_static/images/tribolium.jpg b/_static/images/tribolium.jpg similarity index 100% rename from docs/_static/images/tribolium.jpg rename to _static/images/tribolium.jpg diff --git a/docs/_static/images/tribolium.webm b/_static/images/tribolium.webm similarity index 100% rename from docs/_static/images/tribolium.webm rename to _static/images/tribolium.webm diff --git a/docs/images/update_token_permissions.png b/_static/images/update_token_permissions.png similarity index 100% rename from docs/images/update_token_permissions.png rename to _static/images/update_token_permissions.png diff --git a/docs/_static/images/viewer_pan_zoom.png b/_static/images/viewer_pan_zoom.png similarity index 100% rename from docs/_static/images/viewer_pan_zoom.png rename to _static/images/viewer_pan_zoom.png diff --git a/docs/_static/images/viewer_pan_zoom.webm b/_static/images/viewer_pan_zoom.webm similarity index 100% rename from docs/_static/images/viewer_pan_zoom.webm rename to _static/images/viewer_pan_zoom.webm diff --git a/docs/images/vs_code_debug.png b/_static/images/vs_code_debug.png similarity index 100% rename from docs/images/vs_code_debug.png rename to _static/images/vs_code_debug.png diff --git a/docs/_static/version_switcher.json b/_static/version_switcher.json similarity index 100% rename from docs/_static/version_switcher.json rename to _static/version_switcher.json diff --git a/docs/_templates/autosummary/class.rst b/_templates/autosummary/class.rst similarity index 100% rename from docs/_templates/autosummary/class.rst rename to _templates/autosummary/class.rst diff --git a/docs/_templates/autosummary/module.rst b/_templates/autosummary/module.rst similarity index 100% rename from docs/_templates/autosummary/module.rst rename to _templates/autosummary/module.rst diff --git a/docs/_templates/layout.html b/_templates/layout.html similarity index 100% rename from docs/_templates/layout.html rename to _templates/layout.html diff --git a/docs/_templates/navbar-project.html b/_templates/navbar-project.html similarity index 100% rename from docs/_templates/navbar-project.html rename to _templates/navbar-project.html diff --git a/docs/_templates/sbt-sidebar-footer.html b/_templates/sbt-sidebar-footer.html similarity index 100% rename from docs/_templates/sbt-sidebar-footer.html rename to _templates/sbt-sidebar-footer.html diff --git a/docs/_templates/sidebar-nav-bs.html b/_templates/sidebar-nav-bs.html similarity index 100% rename from docs/_templates/sidebar-nav-bs.html rename to _templates/sidebar-nav-bs.html diff --git a/docs/_toc.yml b/docs/_toc.yml index 75e3da677..86d6752d8 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -1,7 +1,7 @@ root: index subtrees: - entries: - - file: usage + - file: usage/index subtrees: - titlesonly: True entries: @@ -132,105 +132,7 @@ subtrees: - file: community/working_groups - file: community/meeting_schedule - file: community/licensing - - file: developers/index - subtrees: - - entries: - - file: developers/contributing/index - subtrees: - - entries: - - file: developers/contributing/dev_install - - file: developers/contributing/testing - - file: developers/contributing/translations - - file: developers/contributing/performance/index - subtrees: - - entries: - - file: developers/contributing/performance/profiling - - file: developers/contributing/performance/benchmarks - - file: developers/contributing/documentation/index - subtrees: - - entries: - - file: developers/contributing/documentation/docs_template - - file: developers/contributing/documentation/docs_deployment - - file: developers/coredev/core_dev_guide - subtrees: - - entries: - - file: developers/coredev/maintenance - - file: developers/coredev/release - - file: developers/coredev/packaging - - file: developers/architecture/index - subtrees: - - entries: - - file: developers/architecture/dir_organization - - file: developers/architecture/napari_models - - file: developers/architecture/app_model - - file: developers/architecture/magicgui_type_reg - - file: naps/index - subtrees: - - maxdepth: 1 - entries: - - file: naps/0-nap-process - - file: naps/1-institutional-funding-partners - - file: naps/2-conda-based-packaging - - file: naps/3-spaces - - file: naps/4-async-slicing - - file: naps/5-new-logo - - file: naps/6-contributable-menus - - file: naps/7-key-binding-dispatch - - file: naps/8-telemetry - - file: naps/9-multiple-canvases - - file: release/index - subtrees: - - entries: - - file: release/release_0_4_19 - - file: release/release_0_4_18 - - file: release/release_0_4_17 - - file: release/release_0_4_16 - - file: release/release_0_4_15 - - file: release/release_0_4_14 - - file: release/release_0_4_13 - - file: release/release_0_4_12 - - file: release/release_0_4_11 - - file: release/release_0_4_10 - - file: release/release_0_4_9 - - file: release/release_0_4_8 - - file: release/release_0_4_7 - - file: release/release_0_4_6 - - file: release/release_0_4_5 - - file: release/release_0_4_4 - - file: release/release_0_4_3 - - file: release/release_0_4_2 - - file: release/release_0_4_1 - - file: release/release_0_4_0 - - file: release/release_0_3_8 - - file: release/release_0_3_7 - - file: release/release_0_3_6 - - file: release/release_0_3_5 - - file: release/release_0_3_4 - - file: release/release_0_3_3 - - file: release/release_0_3_2 - - file: release/release_0_3_1 - - file: release/release_0_3_0 - - file: release/release_0_2_12 - - file: release/release_0_2_11 - - file: release/release_0_2_10 - - file: release/release_0_2_9 - - file: release/release_0_2_8 - - file: release/release_0_2_7 - - file: release/release_0_2_6 - - file: release/release_0_2_5 - - file: release/release_0_2_4 - - file: release/release_0_2_3 - - file: release/release_0_2_1 - - file: release/release_0_2_0 - - file: release/release_0_1_5 - - file: release/release_0_1_3 - - file: release/release_0_1_0 - - file: roadmaps/index - subtrees: - - entries: - - file: roadmaps/0_4 - - file: roadmaps/0_3_retrospective - - file: roadmaps/0_3 + - file: developers - file: api/index subtrees: - titlesonly: True diff --git a/docs/conf.py b/docs/conf.py index 8626cb6b8..065f4e316 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,8 +111,8 @@ "navbar_persistent": [], "header_links_before_dropdown": 6, "secondary_sidebar_items": ["page-toc"], - "pygment_light_style": "napari", - "pygment_dark_style": "napari", + "pygments_light_style": "napari", + "pygments_dark_style": "napari", "announcement": "https://napari.org/dev/_static/announcement.html", "back_to_top_button": False, } @@ -125,8 +125,8 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] -html_logo = "images/logo.png" +html_static_path = ['../_static'] +html_logo = "../_static/images/logo.png" html_sourcelink_suffix = '' html_title = 'napari' @@ -171,6 +171,10 @@ 'http://app-model.readthedocs.io/en/latest/', 'http://app-model.readthedocs.io/en/latest/objects.inv', ], + 'napari-dev': ( # for napari unversioned pages/development docs + 'https://melissawm.github.io', + (None, '../unversioned/dev_objects.inv') + ) } myst_enable_extensions = [ @@ -221,7 +225,7 @@ def get_supported_python_versions(project_name): suppress_warnings = ['myst.header', 'etoc.toctree'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ['../_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -288,7 +292,7 @@ def napari_scraper(block, block_vars, gallery_conf): 'gallery_dirs': 'gallery', # path to where to save gallery generated output 'filename_pattern': '/*.py', 'ignore_pattern': 'README.rst|/*_.py', - 'default_thumb_file': Path(__file__).parent / 'images' / 'logo.png', + 'default_thumb_file': Path(__file__).parent.parent / '_static' / 'images' / 'logo.png', 'plot_gallery': "'True'", # https://github.com/sphinx-gallery/sphinx-gallery/pull/304/files 'download_all_examples': False, 'min_reported_time': 10, diff --git a/docs/developers.md b/docs/developers.md new file mode 100644 index 000000000..c6d470d01 --- /dev/null +++ b/docs/developers.md @@ -0,0 +1,3 @@ + + +# Contributing diff --git a/docs/howtos/layers/labels.md b/docs/howtos/layers/labels.md index badc22cd7..f9efe13b9 100644 --- a/docs/howtos/layers/labels.md +++ b/docs/howtos/layers/labels.md @@ -75,7 +75,7 @@ layer: Use this tool to manually erase a label on the `labels layer`. Other layers will not be affected. The label eraser tool looks like this: - ![image: eraser tool](../../images/labels-layer-eraser.png) + ![image: eraser tool](../../../_static/images/labels-layer-eraser.png) * **Paintbrush** @@ -306,9 +306,9 @@ common editing tasks on connected components (keep the `contiguous` box checked) ```{raw} html