Skip to content
Merged
Show file tree
Hide file tree
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
Binary file added docs/.jupyterlite.doit.db
Binary file not shown.
25 changes: 25 additions & 0 deletions docs/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.8.0"
nodejs: "18.3.0"

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
- requirements: docs/requirements.txt
8 changes: 5 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
sphinx
sphinx==4.5.0
pygments==2.11.2
myst-parser
pydata-sphinx-theme
myst-parser==0.15.2
jupyterlite==0.1.0b10
pydata-sphinx-theme==0.9.0

3 changes: 3 additions & 0 deletions docs/script_build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
make clean
make html
jupyter lite build --output-dir ./build/html/_output --lite-dir ../jupyterlite
8 changes: 5 additions & 3 deletions docs/source/App/app.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# App

## How to immerse app here? We are able to immerse an html:

<iframe width="672" height="378" src="https://youtube.com/embed/nd7q-N8QAMY" frameborder="0" allowfullscreen></iframe>
<iframe
src="http://127.0.0.1:8000/index.html"
width="100%"
height="600px"
></iframe>


1 change: 1 addition & 0 deletions docs/source/App/test.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import numpy as np
18 changes: 13 additions & 5 deletions docs/source/Contribute/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,17 @@ itkVtkViewer.createViewer(container,
- MyST
- Python and Docutils 0.17+

## Resources
- [Sphinx][https://www.sphinx-doc.org/en/master/index.html]
- [MyST][https://myst-parser.readthedocs.io/en/latest/index.html]
- [Read the docs][https://readthedocs.org/]
- [Sphinx and Markdown course][https://training.talkpython.fm/courses/static-sites-with-sphinx-and-markdown]
For more details on version check the [requirements](https://github.com/InsightSoftwareConsortium/itk-viewer-bootstrap-ui/blob/main/docs/requirements.txt).

After installing python, you can install the dependencies by doing
```
$ cd docs/
$ pip install requirements.txt
```


## Resources
- [Sphinx](https://www.sphinx-doc.org/en/master/index.html)
- [MyST](https://myst-parser.readthedocs.io/en/latest/index.html)
- [Read the docs](https://readthedocs.org/)
- [Sphinx and Markdown course](https://training.talkpython.fm/courses/static-sites-with-sphinx-and-markdown)
1 change: 1 addition & 0 deletions docs/source/_contents/test.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import numpy as np
19 changes: 15 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,25 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["myst_parser"]
# 'sphinx.ext.todo',
extensions = [
# 'jupyterlite_sphinx',
"myst_parser",
'sphinx.ext.intersphinx',
]
# 'sphinx.ext.viewcode',
# 'sphinx.ext.githubpages',
# 'sphinx.ext.intersphinx',
# 'myst_parser',
#]

# Intershpinx mapping
#intersphinx_mapping = {
# 'githubRepo': ('https://github.com/InsightSoftwareConsortium/itk-viewer-bootstrap-ui/', None),
#}

# JupyterLite content
jupyterlite_contents=['App/test.ipynb']
jupyterlite_dir = "."

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down Expand Up @@ -112,7 +123,7 @@
# 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_static_path = ['_static' ]
html_logo = "_static/logo.png"

# Custom sidebar templates, must be a dictionary that maps document names
Expand Down
Binary file added jupyterlite/.jupyterlite.doit.db
Binary file not shown.
Binary file added jupyterlite/files/test-data/HeadMRVolume.nrrd
Binary file not shown.
Binary file not shown.
1 change: 1 addition & 0 deletions jupyterlite/files/test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import numpy as np