Skip to content

Improve readme information #4

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.

Sign up for GitHub

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

Merged
leoRblx merged 1 commit into from
Aug 7, 2025
Merged

Improve readme information #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 0 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,26 +161,6 @@ Sentinel supports both local file storage and S3 storage:

The storage is abstracted using `smart_open`, making it seamless to switch between storage backends.

## Documentation

API documentation is automatically generated and deployed to GitHub Pages on each push to the main branch. You can access the documentation at:

[https://roblox.github.io/sentinel/](https://roblox.github.io/sentinel/)

To build the documentation locally:

```bash
# Install with documentation dependencies
poetry install --with docs

# Generate RST files and build documentation
cd docs
poetry run python generate_docs.py
poetry run sphinx-build -b html source build/html
```

Then open `docs/build/html/index.html` in your browser.

## Examples
To run the notebook examples
```bash
Expand Down