Skip to content

Commit 95d01e2

Browse files
authored
Merge pull request #22 from nolar/full-docs
Migrate the docs from readme to sphinx docs
2 parents 8ae20f0 + 538d90c commit 95d01e2

23 files changed

Lines changed: 1140 additions & 747 deletions
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
description: Documentation style rules for looptime RST files
3+
---
4+
5+
All `.rst` documentation files in this project must follow these styling rules:
6+
7+
### Page Title
8+
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.
9+
10+
Example:
11+
```rst
12+
==========
13+
Page Title
14+
==========
15+
```
16+
17+
### 1st Level Header
18+
The first level header (section) must be underlined with double-equal signs (`=`).
19+
20+
Example:
21+
```rst
22+
Section Name
23+
============
24+
```
25+
26+
### 2nd Level Header
27+
The second level header (sub-section) must be underlined with single-dash characters (`-`).
28+
29+
Example:
30+
```rst
31+
Sub-section Name
32+
----------------
33+
```
34+
35+
### 3rd Level and deeper
36+
If needed, use `~` for 3rd level and `^` for 4th level headers.

.isort.cfg

Lines changed: 0 additions & 6 deletions
This file was deleted.

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
version: 2
4+
formats: all
5+
build:
6+
os: ubuntu-24.04
7+
tools:
8+
python: "3"
9+
jobs:
10+
install:
11+
- pip install --upgrade pip
12+
- pip install --group docs -e .
13+
sphinx:
14+
configuration: docs/conf.py
15+
builder: "dirhtml"
16+
# fail_on_warning: true

0 commit comments

Comments
 (0)