|
| 1 | +# .. Copyright (C) 2012-2020 Bryan A. Jones. |
| 2 | +# |
| 3 | +# This file is part of the CodeChat System. |
| 4 | +# |
| 5 | +# The CodeChat System is free software: you can redistribute it and/or |
| 6 | +# modify it under the terms of the GNU General Public License as |
| 7 | +# published by the Free Software Foundation, either version 3 of the |
| 8 | +# License, or (at your option) any later version. |
| 9 | +# |
| 10 | +# The CodeChat System is distributed in the hope that it will be |
| 11 | +# useful, but WITHOUT ANY WARRANTY; without even the implied warranty |
| 12 | +# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 13 | +# General Public License for more details. |
| 14 | +# |
| 15 | +# You should have received a copy of the GNU General Public License |
| 16 | +# along with the CodeChat System. If not, see |
| 17 | +# <http://www.gnu.org/licenses/>. |
| 18 | +# |
| 19 | +# ************************************************ |
| 20 | +# |docname| - Configuration for a CodeChat project |
| 21 | +# ************************************************ |
| 22 | +# This file defines the configuration for a CodeChat project. It contains a working `Sphinx <https://www.sphinx-doc.org/>`_ configuration. |
| 23 | +# |
| 24 | +# ``source_path``: optional; defaults to ``.`` (the current directory). A path to the root of the source tree. Relative paths are rooted in the directory containing this configuration file. |
| 25 | +source_path: . |
| 26 | + |
| 27 | +# ``output_path``: required. A path to the root of the HTML output produced by this renderer. Relative paths are rooted in the directory containing this configuration file. |
| 28 | +output_path: build/RunestoneComponents |
| 29 | + |
| 30 | +# ``args``: required string or sequence of strings. This provides the arguments to invoke the renderer. These strings may optionally contain the following replacement values: |
| 31 | +# |
| 32 | +# - ``{project_path}``: an absolute path to the directory containing this file. |
| 33 | +# - ``{source_path}``: the ``source_path`` above, but as an absolute path. |
| 34 | +# - ``{output_path}``: the ``output_path`` above, but as an absolute path. |
| 35 | +# |
| 36 | +args: runestone build |
| 37 | + |
| 38 | +# ``html_ext``: optional; defaults to ``.html``. The extension used by this renderer when generating HTML files. |
| 39 | +#html_ext: .html |
0 commit comments