Skip to content

Commit ab9fa9a

Browse files
committed
Updated readme with doc, .toml with sphinx requirements. Deleted useless test workflow.
1 parent 94ebfe2 commit ab9fa9a

File tree

3 files changed

+27
-45
lines changed

3 files changed

+27
-45
lines changed

.github/workflows/run-test.yml

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

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ It provides an efficient and scalable implementation of **Self-Organizing Maps (
2020
- [Table of Contents](#table-of-contents)
2121
- [Introduction](#introduction)
2222
- [Installation](#installation)
23-
<!-- - [Documentation](#documentation) -->
23+
- [Documentation](#documentation)
2424
- [Citation](#citation)
2525
- [Acknowledgement](#acknowledgement)
2626
- [Contributions](#contributions)
@@ -71,9 +71,29 @@ pip install -e '.[dev]' # Install the required dependencies
7171

7272

7373

74-
<!-- ## Documentation
74+
## Documentation
7575

76-
Here is the link to the documentation of this library: [https://ccsd.readthedocs.io/en/latest/](https://ccsd.readthedocs.io/en/latest/). It contains more information regarding all the classes and functions of this package. -->
76+
For more details on classes and functions, please refer to the `TorchSOM` [documentation](https://louistier.github.io/TorchSOM/index.html).
77+
78+
<!--
79+
80+
Generate the `.rst` files with
81+
82+
```bash
83+
sphinx-apidoc -o docs/source torchsom
84+
```
85+
86+
Then, to rebuild everything in [`docs/build/html`](docs/build/html):
87+
88+
```bash
89+
cd docs/
90+
make clean
91+
make html
92+
```
93+
94+
Open [`index.html`](docs/build/html/index.html) to preview locally the generated HTML.
95+
96+
-->
7797

7898

7999

pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,8 @@ dev = [
6666
"pytest-html",
6767
"certifi",
6868
"typing_extensions",
69-
"notebook",
69+
"notebook",
70+
"sphinx",
71+
"sphinx-rtd-theme",
72+
"sphinx-autodoc-typehints",
7073
]

0 commit comments

Comments
 (0)