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

Add more npe2 technical references from the autogenerated content #604

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ prep-docs:
python $(docs_dir)/_scripts/prep_docs.py

docs-build: prep-docs
NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ docs/_build -WT --keep-going -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS)
NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -M html docs/ docs/_build -T --keep-going -D sphinx_gallery_conf.examples_dirs=$(GALLERY_PATH) $(SPHINXOPTS)

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)
33 changes: 33 additions & 0 deletions docs/plugins/technical_references/index.md
Original file line number Diff line number Diff line change
@@ -20,4 +20,37 @@ A reference for the manifest file, which is used to define the plugin and its co
A reference for exactly what can be contributed by a plugin.

:::

:::{grid-item-card} Readers reference
:link: readers-ref
:link-type: ref

A reference for readers that can be contributed by a plugin.

:::

:::{grid-item-card} Writers reference
:link: writers-ref
:link-type: ref

A reference for writers that can be contributed by a plugin.

:::

:::{grid-item-card} Widgets reference
:link: widgets-ref
:link-type: ref

A reference for widgets that can be contributed by a plugin.

:::

:::{grid-item-card} Sample Data reference
:link: sample-data-ref
:link-type: ref

A reference for sample data that can be contributed by a plugin.

:::

::::
4 changes: 4 additions & 0 deletions docs/plugins/technical_references/readers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
(writers-ref)=

```{include} ../_npe2_writers_guide.md
```
4 changes: 4 additions & 0 deletions docs/plugins/technical_references/sample_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
(sample-data-ref)=

```{include} ../_npe2_sample_data_guide.md
```
4 changes: 4 additions & 0 deletions docs/plugins/technical_references/widgets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
(widgets-ref)=

```{include} ../_npe2_widgets_guide.md
```
4 changes: 4 additions & 0 deletions docs/plugins/technical_references/writers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
(writers-ref)=

```{include} ../_npe2_writers.md
```