Skip to content

Commit b897377

Browse files
authored
Update README.md
Complete doc building.
1 parent aead4bb commit b897377

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Documentation (Sphinx)
2+
3+
# 1. Dependencies
4+
5+
# 1.1. Sphinx Basic HTML / RTD Theme
6+
7+
```bash
8+
# apt-get install python3-sphinx python3-sphinx-rtd-theme
9+
```
10+
11+
# 1.2. PDF / Latex
12+
13+
```bash
14+
# apt-get install texlive-full
15+
```
16+
17+
# 2. Build
18+
19+
# 2.1. HTML Documentation
20+
21+
```bash
22+
# make html
23+
# cd ./build/html/
24+
```
25+
26+
# 2.2. PDF / Latex
27+
28+
```bash
29+
# make latexpdf
30+
# cd ./build/latex/
31+
```

0 commit comments

Comments
 (0)