Show More
@@ -59,7 +59,7 b' dist: html' | |||||
59 | cp -al build/html . |
|
59 | cp -al build/html . | |
60 | @echo "Build finished. Final docs are in html/" |
|
60 | @echo "Build finished. Final docs are in html/" | |
61 |
|
61 | |||
62 | html: api autoconfig automagic |
|
62 | html: jsapi api autoconfig automagic | |
63 | html_noapi: clean_api autoconfig automagic |
|
63 | html_noapi: clean_api autoconfig automagic | |
64 |
|
64 | |||
65 | html html_noapi: |
|
65 | html html_noapi: | |
@@ -80,6 +80,9 b' source/config/options/generated:' | |||||
80 | python autogen_config.py |
|
80 | python autogen_config.py | |
81 | @echo "Created docs for config options" |
|
81 | @echo "Created docs for config options" | |
82 |
|
82 | |||
|
83 | jsapi: | |||
|
84 | jsdoc -c jsdoc_config.json -d ./build/jsapi_html/ | |||
|
85 | ||||
83 | api: source/api/generated/gen.txt |
|
86 | api: source/api/generated/gen.txt | |
84 |
|
87 | |||
85 | source/api/generated/gen.txt: |
|
88 | source/api/generated/gen.txt: |
@@ -11,20 +11,22 b' sphinx jsdoc' | |||||
11 |
|
11 | |||
12 | On Debian-based systems, you should be able to run:: |
|
12 | On Debian-based systems, you should be able to run:: | |
13 |
|
13 | |||
14 | sudo apt-get install sphinx npm |
|
14 | sudo apt-get install python-sphinx npm | |
15 | sudo npm install -g jsdoc@"<=3.3.0" |
|
15 | sudo npm install -g jsdoc@"<=3.3.0" | |
16 |
|
16 | |||
17 | The documentation gets built using ``make``, and comes in several flavors. |
|
17 | The documentation gets built using ``make``, and comes in several flavors. | |
18 |
|
18 | |||
19 |
``make html`` - build the API |
|
19 | ``make html`` - build the API (both Javascript and Python) and narrative | |
20 | is the the default ``make`` target, so running just ``make`` is equivalent to |
|
20 | documentation web pages, this is the the default ``make`` target, so | |
21 | ``make html``. |
|
21 | running just ``make`` is equivalent to ``make html``. | |
22 |
|
22 | |||
23 | ``make html_noapi`` - same as above, but without running the auto-generated |
|
23 | ``make html_noapi`` - same as above, but without running the auto-generated | |
24 | API docs. When you are working on the narrative documentation, the most time |
|
24 | API docs. When you are working on the narrative documentation, the most time | |
25 | consuming portion of the build process is the processing and rending of the |
|
25 | consuming portion of the build process is the processing and rending of the | |
26 | API documentation. This build target skips that. |
|
26 | API documentation. This build target skips that. | |
27 |
|
27 | |||
|
28 | ``make jsapi`` - build Javascript auto-generated API documents. | |||
|
29 | ||||
28 | ``make pdf`` will compile a pdf from the documentation. |
|
30 | ``make pdf`` will compile a pdf from the documentation. | |
29 |
|
31 | |||
30 | You can run ``make help`` to see information on all possible make targets. |
|
32 | You can run ``make help`` to see information on all possible make targets. |
@@ -11,6 +11,5 b'' | |||||
11 | "templates": { |
|
11 | "templates": { | |
12 | "cleverLinks": false, |
|
12 | "cleverLinks": false, | |
13 | "monospaceLinks": false |
|
13 | "monospaceLinks": false | |
14 |
} |
|
14 | } | |
15 | "destination": "./out/" |
|
|||
16 | } No newline at end of file |
|
15 | } |
@@ -5,6 +5,7 b' SETLOCAL' | |||||
5 |
|
5 | |||
6 | SET SPHINXOPTS= |
|
6 | SET SPHINXOPTS= | |
7 | SET SPHINXBUILD=sphinx-build |
|
7 | SET SPHINXBUILD=sphinx-build | |
|
8 | SET JSDOC=jsdoc | |||
8 | SET PAPER= |
|
9 | SET PAPER= | |
9 | SET SRCDIR=source |
|
10 | SET SRCDIR=source | |
10 |
|
11 | |||
@@ -43,6 +44,10 b' FOR %%L IN (html pickle htmlhelp latex changes linkcheck) DO (' | |||||
43 | ) |
|
44 | ) | |
44 |
|
45 | |||
45 | IF "%1" == "clean" ( |
|
46 | IF "%1" == "clean" ( | |
|
47 | %JSDOC% -c jsdoc_config.json -d ./build/jsapi_html/ | |||
|
48 | ) | |||
|
49 | ||||
|
50 | IF "%1" == "jsapi" ( | |||
46 | RD /s /q build dist %SRCDIR%\api\generated 2>NUL |
|
51 | RD /s /q build dist %SRCDIR%\api\generated 2>NUL | |
47 | IF ERRORLEVEL 0 ECHO Build environment cleaned! |
|
52 | IF ERRORLEVEL 0 ECHO Build environment cleaned! | |
48 | GOTO END |
|
53 | GOTO END | |
@@ -52,6 +57,7 b' ECHO.' | |||||
52 | ECHO Please use "make [target]" where [target] is one of: |
|
57 | ECHO Please use "make [target]" where [target] is one of: | |
53 | ECHO. |
|
58 | ECHO. | |
54 | ECHO html to make standalone HTML files |
|
59 | ECHO html to make standalone HTML files | |
|
60 | ECHO jsapi to make standalone HTML files for the Javascript API | |||
55 | ECHO pickle to make pickle files (usable by e.g. sphinx-web) |
|
61 | ECHO pickle to make pickle files (usable by e.g. sphinx-web) | |
56 | ECHO htmlhelp to make HTML files and a HTML help project |
|
62 | ECHO htmlhelp to make HTML files and a HTML help project | |
57 | ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
|
63 | ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
General Comments 0
You need to be logged in to leave comments.
Login now