doc/README

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