Skip to content
This repository was archived by the owner on Aug 26, 2020. It is now read-only.

Commit fabbfa1

Browse files
authored
Updated doc compile instructions README
1 parent db7f475 commit fabbfa1

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

docsrc/README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,60 @@
1-
HOW TO COMPILE DEERANALYSIS2 DOCS
1+
## Compiling the documentation
22

3-
Requirements:
4-
Pyhton3
5-
Sphinx 1.8 (or older)
6-
Matlab Sphinx-domain
7-
Read-the-Docs Sphinx-theme
3+
The DeerAnalysis documentation/website is written in restructred-text format and built with Sphinx. In order to compile the source files of the documentation, several packages/programs are required. This is a summary of the steps to be taken before being able to compile the documentation.
4+
5+
### Requirements:
6+
* Pyhton3
7+
* Sphinx 1.8 (or older)
8+
* Matlab Sphinx-domain
9+
* Read-the-Docs Sphinx-theme
810

9-
Installation:
11+
### Installation:
1012

11-
0) Install and setup python environment from
13+
In order to compile the documentation the following steps must be followed:
1214

13-
https://www.python.org/
15+
1) Install and setup python environment from https://www.python.org/
1416

15-
1) Install sphinx
17+
2) Install sphinx
1618

17-
- From python console
19+
* From python console
1820

1921
pip install sphinx<=1.8.0
20-
- From DOS console
22+
* From DOS console
2123

2224
python -m pip install sphinx<=1.8.0
2325

2426
3) Install Read-the-Docs Sphinx theme
2527

26-
- From python console
28+
* From python console
2729

2830
pip install sphinx_rtd_theme
29-
- From DOS console
31+
* From DOS console
3032

3133
python -m pip install sphinx_rtd_theme
3234

33-
2) Install Matlab sphinx-domain
35+
4) Install Matlab sphinx-domain
3436

35-
- From python console
37+
* From python console
3638

3739
pip install sphinxcontrib-matlabdomain
38-
- From DOS console
40+
* From DOS console
3941

4042
python -m pip install sphinxcontrib-matlabdomain
4143

42-
3) Install HTTP sphinx-domain
43-
44-
- From python console
44+
5) Install HTTP sphinx-domain
45+
46+
* From python console
4547

4648
pip install sphinxcontrib-httpdomain
47-
- From DOS console
49+
* From DOS console
4850

4951
python -m pip install sphinxcontrib-httpdomain
5052

51-
4) Download and install dvissvgm from
52-
53-
https://dvisvgm.de/Downloads/
53+
6) Download and install dvissvgm from https://dvisvgm.de/Downloads/
5454

55-
5) From /DeerAnalysis/docsrc/ run the batch script
55+
7) From /DeerAnalysis/docsrc/ run the batch script
5656

57-
make
58-
or
59-
60-
make clean
57+
#To compile using the cached data
58+
make
59+
#To compile from scratch
60+
make clean

0 commit comments

Comments
 (0)