File tree Expand file tree Collapse file tree 1 file changed +4
-0
lines changed Expand file tree Collapse file tree 1 file changed +4
-0
lines changed Original file line number Diff line number Diff line change @@ -429,6 +429,8 @@ Don't forget to commit the baseline image as well.
429
429
430
430
### Documentation
431
431
432
+ #### Building the documentation
433
+
432
434
Most documentation sources are in the ` doc ` folder.
433
435
We use [ sphinx] ( http://www.sphinx-doc.org/ ) to build the web pages from these sources.
434
436
To build the HTML files:
@@ -441,6 +443,8 @@ make all
441
443
This will build the HTML files in ` doc/_build/html ` .
442
444
Open ` doc/_build/html/index.html ` in your browser to view the pages.
443
445
446
+ #### Cross-referencing with Sphinx
447
+
444
448
The API reference is manually assembled in ` doc/api/index.rst ` .
445
449
The * autodoc* sphinx extension will automatically create pages for each
446
450
function/class/module listed there.
You can’t perform that action at this time.
0 commit comments