Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
36 changes: 36 additions & 0 deletions .agent/workflows/documentation_style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
description: Documentation style rules for looptime RST files
---

All `.rst` documentation files in this project must follow these styling rules:

### Page Title
The page title must be enclosed in double-equal signs (`=`) both on top and at the bottom. The length of the underline/overline must match the title length.

Example:
```rst
==========
Page Title
==========
```

### 1st Level Header
The first level header (section) must be underlined with double-equal signs (`=`).

Example:
```rst
Section Name
============
```

### 2nd Level Header
The second level header (sub-section) must be underlined with single-dash characters (`-`).

Example:
```rst
Sub-section Name
----------------
```

### 3rd Level and deeper
If needed, use `~` for 3rd level and `^` for 4th level headers.
6 changes: 0 additions & 6 deletions .isort.cfg

This file was deleted.

16 changes: 16 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
formats: all
build:
os: ubuntu-24.04
tools:
python: "3"
jobs:
install:
- pip install --upgrade pip
- pip install --group docs -e .
sphinx:
configuration: docs/conf.py
builder: "dirhtml"
# fail_on_warning: true
Loading
Loading