diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README-building.txt | 10 | ||||
| -rw-r--r-- | docs/source/conf.py | 10 |
2 files changed, 9 insertions, 11 deletions
diff --git a/docs/README-building.txt b/docs/README-building.txt index de4a7f7..6846bf7 100644 --- a/docs/README-building.txt +++ b/docs/README-building.txt @@ -44,11 +44,9 @@ and Breathe). - Everyone else, clone without them: $ git clone git://github.com/leaflabs/breathe.git -4. After that's done, set environment variables LIB_MAPLE_HOME to - point to libmaple, and BREATHE_HOME to point to Breathe. Something - like this in Bash: +4. After that's done, set environment variable BREATHE_HOME to point to + Breathe. Something like this in Bash: - $ export LIB_MAPLE_HOME=/path/to/libmaple/repo/ $ export BREATHE_HOME=/path/to/breathe/repo/ (You'll want this in your shell startup script.) @@ -63,14 +61,14 @@ produce Doxygen XML output, then you can generate the final HTML docs. comments in the libmaple source code are changed), you'll need to re-run doxygen on libmaple. - $ cd /path/to/libmaple + $ cd /path/to/top/level $ make doxygen Doxygen will yell at you a lot; it's generally safe to ignore it. 2. Finally, you can build the HTML (in the leaflabs-docs repository): - $ cd /path/to/leaflabs-docs + $ cd /path/to/docs $ make html On Windows, you can supposedly use the batch file make.bat instead. diff --git a/docs/source/conf.py b/docs/source/conf.py index b1126df..fe400d0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -267,16 +267,16 @@ man_pages = [ # -- Options for breathe integration ------------------------------------------ -# We allow people to check in Doxygen XML into maintenance branches. +# Check to see if doxygen has been run yet doxygen_xml_maybe = os.path.join(os.path.dirname(os.path.dirname(__file__)), - 'doxygen', 'xml') + '..', 'doxygen', 'xml') if os.path.isdir(doxygen_xml_maybe): # There's a doxygen/xml/ directory in this repository root, use that. doxygen_xml_dir = doxygen_xml_maybe else: - # Nothing there, assume it's in LIB_MAPLE_HOME. - doxygen_xml_dir = os.path.join(os.environ['LIB_MAPLE_HOME'], - 'doxygen', 'xml') + print("FAIL: doxygen hasn't been run yet in this repository; " + "see ../README") + sys.exit(-1) breathe_projects = {'libmaple' : doxygen_xml_dir} |