Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ repos:
rev: v1.18.2
hooks:
- id: mypy
exclude: ^docs/examples/
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

47 changes: 47 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Widgetastic.Core Documentation

This directory contains the comprehensive documentation for widgetastic.core, providing a superior learning experience for developers using this powerful web automation framework.

## 🏗️ Building the Documentation

### Prerequisites

```bash
# For the full documentation experience, install widgetastic.core with doc dependencies.
pip install -e .[docs]
```

### Building HTML Documentation

From the project root:

```bash
cd docs
sphinx-build -b html . _build/html
```

The documentation will be built in `_build/html/`. Open `_build/html/index.html` in your browser to view.

### Live Development Server

For live reloading during development:

```bash
sphinx-autobuild . _build/html --watch ../src
```

This will start a development server at `http://localhost:8000` with automatic rebuilding when files change.

### Building Other Formats

```bash
# PDF documentation
sphinx-build -b latex . _build/latex
cd _build/latex && make

# EPUB format
sphinx-build -b epub . _build/epub

# Single HTML file
sphinx-build -b singlehtml . _build/singlehtml
```
312 changes: 0 additions & 312 deletions docs/advanced_usage.rst

This file was deleted.

Loading
Loading