|
1 | | -HOW TO COMPILE DEERANALYSIS2 DOCS |
| 1 | +## Compiling the documentation |
2 | 2 |
|
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 |
8 | 10 |
|
9 | | -Installation: |
| 11 | +### Installation: |
10 | 12 |
|
11 | | -0) Install and setup python environment from |
| 13 | +In order to compile the documentation the following steps must be followed: |
12 | 14 |
|
13 | | - https://www.python.org/ |
| 15 | +1) Install and setup python environment from https://www.python.org/ |
14 | 16 |
|
15 | | -1) Install sphinx |
| 17 | +2) Install sphinx |
16 | 18 |
|
17 | | - - From python console |
| 19 | + * From python console |
18 | 20 |
|
19 | 21 | pip install sphinx<=1.8.0 |
20 | | - - From DOS console |
| 22 | + * From DOS console |
21 | 23 |
|
22 | 24 | python -m pip install sphinx<=1.8.0 |
23 | 25 |
|
24 | 26 | 3) Install Read-the-Docs Sphinx theme |
25 | 27 |
|
26 | | - - From python console |
| 28 | + * From python console |
27 | 29 |
|
28 | 30 | pip install sphinx_rtd_theme |
29 | | - - From DOS console |
| 31 | + * From DOS console |
30 | 32 |
|
31 | 33 | python -m pip install sphinx_rtd_theme |
32 | 34 |
|
33 | | -2) Install Matlab sphinx-domain |
| 35 | +4) Install Matlab sphinx-domain |
34 | 36 |
|
35 | | - - From python console |
| 37 | + * From python console |
36 | 38 |
|
37 | 39 | pip install sphinxcontrib-matlabdomain |
38 | | - - From DOS console |
| 40 | + * From DOS console |
39 | 41 |
|
40 | 42 | python -m pip install sphinxcontrib-matlabdomain |
41 | 43 |
|
42 | | -3) Install HTTP sphinx-domain |
43 | | - |
44 | | - - From python console |
| 44 | +5) Install HTTP sphinx-domain |
| 45 | + |
| 46 | + * From python console |
45 | 47 |
|
46 | 48 | pip install sphinxcontrib-httpdomain |
47 | | - - From DOS console |
| 49 | + * From DOS console |
48 | 50 |
|
49 | 51 | python -m pip install sphinxcontrib-httpdomain |
50 | 52 |
|
51 | | -4) Download and install dvissvgm from |
52 | | - |
53 | | - https://dvisvgm.de/Downloads/ |
| 53 | +6) Download and install dvissvgm from https://dvisvgm.de/Downloads/ |
54 | 54 |
|
55 | | -5) From /DeerAnalysis/docsrc/ run the batch script |
| 55 | +7) From /DeerAnalysis/docsrc/ run the batch script |
56 | 56 |
|
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