1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
This is the documentation tree for libctl.
Markdown (.md) files for libctl documentation live in $(top_src_dir)/doc/docs.
To build and visualize the HTML documentation locally using the
mkdocs package (useful for verifying on your local machine before
committing), install the `mkdocs` package, then run the
following command from the top-level meep repository tree:
% mkdocs serve
and then open the following URL in a browser window:
http://127.0.0.1:8000/libctl
This launches a little web server on your local machine
plus a filesystem hook for rebuilding the documentation
tree automatically whenever any .md file is modified, so
you can see what the actual HTML documentation looks
like in real time as you edit the source.
|
