Materials Cloud的Voilà模板。
项目描述
Materials Cloud的Voilà模板
这是Materials Cloud的Voilà模板，实现了标准页眉和CSS。
提供了三个模板
materialscloud-tool- 在页眉/面包屑中突出显示WORK/工具部分。materialscloud-discover- 在页眉/面包屑中突出显示DISCOVER部分。materialscloud-iframe- 仅在底部添加一个简单的“托管于Materials Cloud”说明。
安装
pip install voila-materialscloud-template
这将安装模板到正确的Jupyter路径（使用copy_voila_template.py）。
使用方法
主要方式是使用voila --template选项，例如。
voila --template=materialscloud-tool example.ipynb
或者，您可以编写一个包含
{
"VoilaConfiguration": {
"template": "materialscloud-tool"
},
...
}
并通过以下方式传递其路径
voila --Voila.config_file_paths=<...> example.ipynb
还有其他选项，有关更多信息，请参阅Voilà文档。
开发
选项1
pip install -e .[dev]
注意：这将复制模板到jupyter文件夹，并且需要直接在那里修改或重新复制以使更改生效。
选项2
使用docker容器并修改后重建会更方便。
cd docker
docker compose up --build
通过 https://:8866/ 访问。模板和其他 Voilà 配置在 voila.json 中指定。
注意：可能存在更简单的设置方式，例如使用 live-reload 或类似工具。
发布新版本
要发布新版本，只需在 GitHub 上创建带有正确版本标签的新版本，无需手动更新任何版本。这将启动 GitHub 动作，该动作将
- 更新存储库中的版本号并将提交；
- 将新提交标记为版本，覆盖 GitHub 发布创建的标签；
- 将提交和标签推送到 GitHub；
- 在 PYPI 上发布新版本。
许可证
本存储库及其所有文件均受 BSD 许可协议许可，版权由 Voilà 贡献者所有。
下载文件
下载您平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源代码分发
voila_materialscloud_template-0.4.3.tar.gz (445.6 kB 查看散列值)
