Skip to content

Commit 16d05a9

Browse files
seismanMeghan Jones
andcommitted
Add two subsection headers in the Documentation section
Co-authored-by: Meghan Jones <[email protected]>
1 parent 9e8ecc1 commit 16d05a9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,8 @@ Don't forget to commit the baseline image as well.
429429

430430
### Documentation
431431

432+
#### Building the documentation
433+
432434
Most documentation sources are in the `doc` folder.
433435
We use [sphinx](http://www.sphinx-doc.org/) to build the web pages from these sources.
434436
To build the HTML files:
@@ -441,6 +443,8 @@ make all
441443
This will build the HTML files in `doc/_build/html`.
442444
Open `doc/_build/html/index.html` in your browser to view the pages.
443445

446+
#### Cross-referencing with Sphinx
447+
444448
The API reference is manually assembled in `doc/api/index.rst`.
445449
The *autodoc* sphinx extension will automatically create pages for each
446450
function/class/module listed there.

0 commit comments

Comments
 (0)