Use autoapi_root for url root configuration

autoapi/extension.py

@@ -12,7 +12,7 @@ from sphinx.addnodes import toctree
 from sphinx.errors import ExtensionError
 
 from .backends import default_file_mapping, default_ignore_patterns, default_backend_mapping
-from .settings import URL_ROOT
+from .settings import API_ROOT
 
 default_options = ['members', 'undoc-members', 'private-members', 'special-members']
 
@@ -45,12 +45,13 @@ def run_autoapi(app):
             )
 
     normalized_root = os.path.normpath(os.path.join(app.confdir, app.config.autoapi_root))
+    url_root = os.path.join('/', app.config.autoapi_root)
 
     app.env.autoapi_data = []
 
     domain = default_backend_mapping[app.config.autoapi_type]
     domain_obj = domain(app, template_dir=app.config.autoapi_template_dir,
-                        url_root=app.config.autoapi_url_root)
+                        url_root=url_root)
 
     if app.config.autoapi_file_patterns:
         file_patterns = app.config.autoapi_file_patterns
@@ -118,7 +119,7 @@ def setup(app):
     app.connect('build-finished', build_finished)
     app.connect('doctree-read', doctree_read)
     app.add_config_value('autoapi_type', 'python', 'html')
-    app.add_config_value('autoapi_root', 'autoapi', 'html')
+    app.add_config_value('autoapi_root', API_ROOT, 'html')
     app.add_config_value('autoapi_ignore', [], 'html')
     app.add_config_value('autoapi_options', default_options, 'html')
     app.add_config_value('autoapi_file_patterns', None, 'html')
@@ -126,5 +127,4 @@ def setup(app):
     app.add_config_value('autoapi_keep_files', False, 'html')
     app.add_config_value('autoapi_add_toctree_entry', True, 'html')
     app.add_config_value('autoapi_template_dir', [], 'html')
-    app.add_config_value('autoapi_url_root', URL_ROOT, 'html')
     app.add_stylesheet('autoapi.css')

autoapi/mappers/base.py

@@ -8,7 +8,7 @@ from jinja2 import Environment, FileSystemLoader, TemplateNotFound
 from sphinx.util.console import darkgreen, bold
 from sphinx.util.osutil import ensuredir
 
-from ..settings import URL_ROOT
+from ..settings import API_ROOT
 
 
 class PythonMapperBase(object):
@@ -53,7 +53,7 @@ class PythonMapperBase(object):
         if jinja_env:
             self.jinja_env = jinja_env
         if url_root is None:
-            url_root = URL_ROOT
+            url_root = os.path.join('/', API_ROOT)
         self.url_root = url_root
 
     def render(self, **kwargs):

autoapi/settings.py

@@ -10,4 +10,4 @@ import os
 SITE_ROOT = os.path.dirname(os.path.realpath(__file__))
 TEMPLATE_DIR = os.path.join(SITE_ROOT, 'templates')
 
-URL_ROOT = '/autoapi'
+API_ROOT = 'autoapi'

docs/config.rst

@@ -55,7 +55,7 @@ Customization Options
 
 	Default: ``autoapi``
 
-	Directory to output the AutoAPI files into
+	Relative path to output the AutoAPI files into
 
 Debugging Options
 -----------------