From 3acf30b3aa9d072ee6a87e45207170c5033183c0 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 4 Apr 2012 18:45:26 +0000 Subject: [PATCH] Moved build directories for docs to make relative links consistent --- SConstruct | 4 ++-- doc/SConscript | 11 +++++++---- doc/doxygen/Doxyfile | 2 +- doc/sphinx/conf.py | 2 +- doc/sphinx/index.rst | 4 +++- doc/sphinx/python/func.rst | 10 ++++++---- 6 files changed, 20 insertions(+), 13 deletions(-) diff --git a/SConstruct b/SConstruct index dd81cbe4e..ef93dd37b 100644 --- a/SConstruct +++ b/SConstruct @@ -569,8 +569,8 @@ opts.AddVariables( 'kernel' subdirectory in previous versions of Cantera.""", False), PathVariable( - 'graphvisdir', - """The directory location of the graphviz program, dot. dot is + 'graphvizdir', + """The directory location of the graphviz program, "dot". dot is used for creating the documentation, and for making reaction path diagrams. If "dot" is in your path, you can leave this unspecified. NOTE: Matlab comes with a diff --git a/doc/SConscript b/doc/SConscript index 1049e193e..80533ba27 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -5,13 +5,16 @@ Import('env', 'build', 'install') localenv = env.Clone() if localenv['doxygen_docs']: - build(localenv.Command('#build/docs/html/index.html', + if localenv['graphvizdir']: + localenv.Append(PATH=localenv['graphvizdir']) + + build(localenv.Command('#build/docs/doxygen/html/index.html', 'doxygen/Doxyfile', 'doxygen $SOURCE')) - install(pjoin('$inst_docdir', 'html'), - mglob(localenv, '#/build/docs/html', 'html', 'svg', 'css', 'png')) + install(pjoin('$inst_docdir', 'doxygen/html'), + mglob(localenv, '#/build/docs/doxygen/html', 'html', 'svg', 'css', 'png')) if localenv['sphinx_docs']: - localenv['SPHINXBUILD'] = Dir('#build/sphinx') + localenv['SPHINXBUILD'] = Dir('#build/docs/sphinx') localenv['SPHINXSRC'] = Dir('sphinx') sphinxdocs = build(localenv.Command('${SPHINXBUILD}/html/index.html', diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index 9c5b27090..d6002fddc 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -47,7 +47,7 @@ PROJECT_NUMBER = 2.0 # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = build/docs +OUTPUT_DIRECTORY = build/docs/doxygen # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 9c7b2c5b9..2da13b7b3 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -44,7 +44,7 @@ mathjax_path = 'http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=default' doxylink = { 'ct' : (os.path.abspath('../../build/docs/Cantera.tag'), - '../../docs/html/') + '../../doxygen/html/') } # Add any paths that contain templates here, relative to this directory. diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 1d180f579..2ba0d9126 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -16,9 +16,11 @@ Contents python/index C++ Introduction - C++ API Documentation + Cantera Development Homepage +* `C++ API Documentation <../../doxygen/html/index.html>`_ + Indexes ======= diff --git a/doc/sphinx/python/func.rst b/doc/sphinx/python/func.rst index 546bf62f3..73f7b9703 100644 --- a/doc/sphinx/python/func.rst +++ b/doc/sphinx/python/func.rst @@ -1,11 +1,13 @@ Func Module =========== +.. py:currentmodule:: Func + Quick links: - * :class:`.Polynomial` - * :class:`.Gaussian` - * :class:`.Fourier` - * :class:`.Arrhenius` + * :class:`Polynomial` + * :class:`Gaussian` + * :class:`Fourier` + * :class:`Arrhenius` .. automodule:: Cantera.Func :member-order: bysource