Skip to content

Commit f58feea

Browse files
committed
docs: add Sphinx documentation with MyST and autodoc integration
1 parent 43f9d93 commit f58feea

File tree

4 files changed

+23
-8
lines changed

4 files changed

+23
-8
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import sys
1010
sys.path.insert(0, os.path.abspath('../../gen_surv'))
1111

12-
project = 'gen_suv'
12+
project = 'gen_suvr'
1313
copyright = '2025, Diogo Ribeiro'
1414
author = 'Diogo Ribeiro'
1515
release = '0.2.0'

docs/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ It includes generators for:
2020
modules
2121
```
2222

23+
2324
# 🚀 Usage Example
2425

2526
```python

docs/source/modules.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# API Reference
2+
3+
::: gen_surv.cphm
4+
options:
5+
members: true
6+
undoc-members: true
7+
8+
::: gen_surv.cmm
9+
options:
10+
members: true
11+
undoc-members: true
12+
13+
::: gen_surv.tdcm
14+
options:
15+
members: true
16+
undoc-members: true
17+
18+
::: gen_surv.thmm
19+
options:
20+
members: true
21+
undoc-members: true

docs/source/modules.rst

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

0 commit comments

Comments
 (0)