Skip to content

Commit a17744b

Browse files
committed
Add Readme file to docs folder.
1 parent 471d3d8 commit a17744b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/Readme.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Sphinx documentation
2+
3+
It uses the [sphinx](https://www.sphinx-doc.org/en/master/) package.
4+
5+
### Requirements:
6+
7+
It's necessary to install two additional packages:
8+
9+
```bash
10+
pip install sphinx-rtd-theme
11+
pip install sphinx-markdown-builder
12+
```
13+
14+
### Update `rst` files:
15+
16+
```bash
17+
sphinx-apidoc -o . ..
18+
```
19+
20+
### Create documentation
21+
22+
In html:
23+
24+
```bash
25+
make html
26+
```
27+
In markdown
28+
29+
```bash
30+
make markdown
31+
```

0 commit comments

Comments
 (0)