Skip to content

Conversation

Copy link

Copilot AI commented Oct 7, 2025

This PR implements a complete Jupyter Book template containing several tutorials for the Rudof project, providing a professional, extensible documentation framework.

Overview

The repository now contains a fully functional Jupyter Book setup with three comprehensive tutorials covering Rudof installation, basic usage, and advanced features. The book is production-ready and can be built and deployed immediately.

What's Included

Book Structure

  • Introduction page (intro.md) - Welcome page explaining Rudof, tutorial contents, prerequisites, and help resources
  • Tutorial 1: Getting Started - Installation via Cargo and building from source, verification steps, and basic command structure
  • Tutorial 2: Basic Usage - Working with RDF data, ShEx and SHACL validation, output formats, and common options
  • Tutorial 3: Advanced Features - Complex validation scenarios with shape maps, data conversion, schema analysis, performance optimization, and programmatic usage examples

Configuration & Build Tools

  • _config.yml - Complete Jupyter Book configuration with repository integration, execution settings, and bibliography support
  • _toc.yml - Table of contents defining the book navigation structure
  • Makefile - Convenient commands for common tasks (install, build, clean, serve)
  • requirements.txt - Python dependencies (jupyter-book, matplotlib, numpy)
  • references.bib - BibTeX file for academic citations

Documentation

  • Updated README.md - Comprehensive instructions for building the book, adding new tutorials, and contributing
  • Updated .gitignore - Excludes build artifacts (_build/, .jupyter_cache/)

Usage

Build and view the book:

# Install dependencies
pip install -r requirements.txt

# Build the book
jupyter-book build .

# Or use the Makefile
make install
make build
make serve

The built HTML will be available in _build/html/ directory.

Features

✅ Professional sphinx-book-theme with clean, modern design
✅ Sidebar navigation with all tutorials
✅ Syntax-highlighted code blocks with copy buttons
✅ GitHub integration (repository and issue buttons)
✅ Responsive design for desktop and mobile
✅ Built-in search functionality
✅ Bibliography support for citations
✅ Easy to extend with additional tutorials

Screenshots

Homepage:
Jupyter Book Homepage

Tutorial Page:
Getting Started Tutorial

Adding New Tutorials

To add more tutorials:

  1. Create a new markdown file in the tutorials/ directory
  2. Add the file to _toc.yml in the chapters section
  3. Run jupyter-book build . to rebuild

The template is designed to be easily extensible for future content additions.

Original prompt

I want a template that contains several tutorials using jupyter books


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits October 7, 2025 08:44
Co-authored-by: labra <308369+labra@users.noreply.github.com>
Co-authored-by: labra <308369+labra@users.noreply.github.com>
Copilot AI changed the title [WIP] I want a template that contains several tutorials using jupyter books Add Jupyter Book template with comprehensive tutorials for Rudof Oct 7, 2025
Copilot AI requested a review from labra October 7, 2025 08:47
Copilot finished work on behalf of labra October 7, 2025 08:47
@labra
Copy link
Member

labra commented Oct 28, 2025

I close this PR because at the end I did manually

@labra labra closed this Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants