diff --git a/docs/.jupyterlite.doit.db b/docs/.jupyterlite.doit.db new file mode 100644 index 0000000..c4e27a3 Binary files /dev/null and b/docs/.jupyterlite.doit.db differ diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml new file mode 100644 index 0000000..ef449c2 --- /dev/null +++ b/docs/.readthedocs.yaml @@ -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 diff --git a/docs/requirements.txt b/docs/requirements.txt index 83debac..6d78f9d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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 + diff --git a/docs/script_build.sh b/docs/script_build.sh new file mode 100644 index 0000000..c465283 --- /dev/null +++ b/docs/script_build.sh @@ -0,0 +1,3 @@ +make clean +make html +jupyter lite build --output-dir ./build/html/_output --lite-dir ../jupyterlite diff --git a/docs/source/App/app.md b/docs/source/App/app.md index 4192e0a..6623692 100644 --- a/docs/source/App/app.md +++ b/docs/source/App/app.md @@ -1,7 +1,9 @@ # App -## How to immerse app here? We are able to immerse an html: - - + diff --git a/docs/source/App/test.ipynb b/docs/source/App/test.ipynb new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/docs/source/App/test.ipynb @@ -0,0 +1 @@ +import numpy as np diff --git a/docs/source/Contribute/contribute.md b/docs/source/Contribute/contribute.md index 10eb14b..0a92a54 100644 --- a/docs/source/Contribute/contribute.md +++ b/docs/source/Contribute/contribute.md @@ -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) diff --git a/docs/source/_contents/test.ipynb b/docs/source/_contents/test.ipynb new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/docs/source/_contents/test.ipynb @@ -0,0 +1 @@ +import numpy as np diff --git a/docs/source/conf.py b/docs/source/conf.py index c5abe52..97e5be5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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'] @@ -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 diff --git a/jupyterlite/.jupyterlite.doit.db b/jupyterlite/.jupyterlite.doit.db new file mode 100644 index 0000000..d577a02 Binary files /dev/null and b/jupyterlite/.jupyterlite.doit.db differ diff --git a/jupyterlite/files/test-data/HeadMRVolume.nrrd b/jupyterlite/files/test-data/HeadMRVolume.nrrd new file mode 100644 index 0000000..3309957 Binary files /dev/null and b/jupyterlite/files/test-data/HeadMRVolume.nrrd differ diff --git a/jupyterlite/files/test-data/HeadMRVolumeLabels.nrrd b/jupyterlite/files/test-data/HeadMRVolumeLabels.nrrd new file mode 100644 index 0000000..e4d9e41 Binary files /dev/null and b/jupyterlite/files/test-data/HeadMRVolumeLabels.nrrd differ diff --git a/jupyterlite/files/test.py b/jupyterlite/files/test.py new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/jupyterlite/files/test.py @@ -0,0 +1 @@ +import numpy as np