Moved build directories for docs to make relative links consistent

This commit is contained in:
Ray Speth 2012-04-04 18:45:26 +00:00
parent e4eba2c5f7
commit 3acf30b3aa
6 changed files with 20 additions and 13 deletions

View file

@ -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

View file

@ -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',

View file

@ -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

View file

@ -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.

View file

@ -16,9 +16,11 @@ Contents
python/index
C++ Introduction <cxx-intro>
C++ API Documentation <http://cantera.github.com/docs/index.html>
Cantera Development Homepage <http://cantera.googlecode.com>
* `C++ API Documentation <../../doxygen/html/index.html>`_
Indexes
=======

View file

@ -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