Skip to content

Commit ae44225

Browse files
committed
Update docs and README
1 parent 54d203e commit ae44225

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,11 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on setting up your
131131
If you use **gen_surv** in your work, please cite it using the metadata in
132132
[`CITATION.cff`](CITATION.cff). Many reference managers can import this file
133133
directly.
134+
135+
## Author
136+
137+
**Diogo Ribeiro**[ESMAD - Instituto Politécnico do Porto](https://esmad.ipp.pt)
138+
139+
- ORCID: <https://orcid.org/0009-0001-2022-7072>
140+
- Professional email: <[email protected]>
141+
- Personal email: <[email protected]>

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
import sys
1010
sys.path.insert(0, os.path.abspath('../../gen_surv'))
1111

12-
project = 'gen_suvr'
12+
project = 'gen_surv'
1313
copyright = '2025, Diogo Ribeiro'
1414
author = 'Diogo Ribeiro'
15-
release = '0.6.3'
15+
release = '1.0.3'
1616

1717
# -- General configuration ---------------------------------------------------
1818
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,16 @@ python -m gen_surv dataset aft_ln --n 100 > data.csv
6262
- [Source Code](https://github.com/DiogoRibeiro7/genSurvPy)
6363
- [License](https://github.com/DiogoRibeiro7/genSurvPy/blob/main/LICENSE)
6464
- [Code of Conduct](https://github.com/DiogoRibeiro7/genSurvPy/blob/main/CODE_OF_CONDUCT.md)
65+
66+
## Citation
67+
68+
If you use **gen_surv** in your work, please cite it using the metadata in
69+
[CITATION.cff](../../CITATION.cff).
70+
71+
## Author
72+
73+
**Diogo Ribeiro**[ESMAD - Instituto Politécnico do Porto](https://esmad.ipp.pt)
74+
75+
- ORCID: <https://orcid.org/0009-0001-2022-7072>
76+
- Professional email: <[email protected]>
77+
- Personal email: <[email protected]>

docs/source/modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323
::: gen_surv.interface
2424
options:
2525
members: true
26-
undoc-members: tru
26+
undoc-members: true
2727

2828
::: gen_surv.aft
2929
options:
3030
members: true
31-
undoc-members: true
31+
undoc-members: true

0 commit comments

Comments
 (0)