Skip to content

Commit e80915d

Browse files
authored
Improve readme information (#4)
1 parent bfd6712 commit e80915d

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -161,26 +161,6 @@ Sentinel supports both local file storage and S3 storage:
161161

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

164-
## Documentation
165-
166-
API documentation is automatically generated and deployed to GitHub Pages on each push to the main branch. You can access the documentation at:
167-
168-
[https://roblox.github.io/sentinel/](https://roblox.github.io/sentinel/)
169-
170-
To build the documentation locally:
171-
172-
```bash
173-
# Install with documentation dependencies
174-
poetry install --with docs
175-
176-
# Generate RST files and build documentation
177-
cd docs
178-
poetry run python generate_docs.py
179-
poetry run sphinx-build -b html source build/html
180-
```
181-
182-
Then open `docs/build/html/index.html` in your browser.
183-
184164
## Examples
185165
To run the notebook examples
186166
```bash

0 commit comments

Comments
 (0)