Permalink
Browse files

Oops, forgot to remove abspaths.

  • Loading branch information...
1 parent 7c47351 commit d881ba9c018911ac65e7e443eeb8608f5a236a78 @Ciantic committed Apr 7, 2010
Showing with 12 additions and 11 deletions.
  1. +8 −7 src/sphinkydocext/__init__.py
  2. +4 −4 src/sphinkydocext/generate.py
@@ -59,13 +59,14 @@
.. confval:: sphinkydoc_modules_dir
Directory where to *output* the generated module docs as
- ``module.submodule.rst``. Defaults to same directory as `conf.py` of your
- project.
+ ``module.submodule.rst``. **Must be relative to sources directory.**
+ Defaults to root of source directory.
.. confval:: sphinkydoc_scripts_dir
Directory where to *output* the generated script docs as ``script.py.rst``.
- Defaults to same directory as `conf.py` of your project.
+ **Must be relative to sources directory.** Defaults to root of source
+ directory.
.. confval:: sphinkydoc_docs_dir
@@ -191,8 +192,8 @@ def builder_inited(app):
# Gather configuration directories
docs_dir = conf.sphinkydoc_docs_dir
caps_dir = conf.sphinkydoc_caps_dir
- module_dir = truncate_path(conf.sphinkydoc_modules_dir, directory=app.srcdir)
- script_dir = truncate_path(conf.sphinkydoc_scripts_dir, directory=app.srcdir)
+ module_dir = conf.sphinkydoc_modules_dir
+ script_dir = conf.sphinkydoc_scripts_dir
# Convert paths to abspaths if they are not already
# if module_dir:
@@ -324,8 +325,8 @@ def setup(app):
app.add_config_value('sphinkydoc_index', False, '')
app.add_config_value('sphinkydoc_readme_html', False, '')
app.add_config_value('sphinkydoc_docs_dir', None, '')
- app.add_config_value('sphinkydoc_modules_dir', app.srcdir, '')
- app.add_config_value('sphinkydoc_scripts_dir', app.srcdir, '')
+ app.add_config_value('sphinkydoc_modules_dir', "", '')
+ app.add_config_value('sphinkydoc_scripts_dir', "", '')
app.add_config_value('sphinkydoc_caps_dir', None, '')
#app.add_config_value('sphinkydoc_magic_files', )
#app.setup_extension('sphinkydocext')
@@ -122,8 +122,8 @@ def conf_py(tenv, tcontext, output_dir=None, overwrite=False):
return filename
-def all_doc(tenv, module_names=None, script_paths=None, module_output_dir=None,
- script_output_dir=None, module_overwrite=False,
+def all_doc(tenv, module_names=None, script_paths=None, module_output_dir="",
+ script_output_dir="", module_overwrite=False,
script_overwrite=False):
"""Generates documentation for modules and scripts.
@@ -137,13 +137,13 @@ def all_doc(tenv, module_names=None, script_paths=None, module_output_dir=None,
for these.
:param module_output_dir: Output directory of generated module documents.
+ **Must be relative path to source root.**
:param script_output_dir: Output directory of generated script documents.
+ **Must be relative path to source root.**
:returns: Tuple of generated module paths, and generated script paths.
"""
- module_output_dir = module_output_dir or os.path.abspath(".")
- script_output_dir = script_output_dir or os.path.abspath(".")
module_names = module_names or []
script_paths = script_paths or []

0 comments on commit d881ba9

Please sign in to comment.