Merge pull request #6082 from readthedocs/humitos/full-path-url-docurl

Return full path URL (including `.html`) on `/api/v2/docurl/` endpoint

Author: ericholscher

readthedocs/api/v2/views/core_views.py

@@ -20,11 +20,16 @@ def docurl(request):
 
     Example::
 
-        GET https://readthedocs.org/api/v2/docurl/?project=requests&version=latest&doc=index
+        GET https://readthedocs.org/api/v2/docurl/?
+          project=requests&
+          version=latest&
+          doc=index&
+          path=index.html
     """
     project = request.GET.get('project')
     version = request.GET.get('version', LATEST)
     doc = request.GET.get('doc', 'index')
+    path = request.GET.get('path', '')
     if project is None:
         return Response(
             {'error': 'Need project and doc'},
@@ -42,5 +47,6 @@ def docurl(request):
             project=project,
             version=version.slug,
             page=doc,
+            path=path,
         ),
     })

readthedocs/core/templatetags/core_tags.py

@@ -37,10 +37,20 @@ def gravatar(email, size=48):
 
 
 @register.simple_tag(name='doc_url')
-def make_document_url(project, version=None, page=''):
+def make_document_url(project, version=None, page='', path=''):
+    """
+    Create a URL for a Project, Version and page (and/or path).
+
+    :param page: is the name of the document as Sphinx call it (e.g.
+        /config-file/v1) (note that the extension is not present)
+    :param path: is the full path of the page (e.g. /section/configuration.html)
+
+    :returns: URL to the page (e.g. https://docs.domain.com/en/latest/section/configuration.html)
+    """
     if not project:
         return ''
-    return resolve(project=project, version_slug=version, filename=page)
+    filename = path or page
+    return resolve(project=project, version_slug=version, filename=filename)
 
 
 @register.filter(is_safe=True)

readthedocs/rtd_tests/tests/test_core_tags.py

@@ -67,32 +67,29 @@ def test_project_and_version_and_page(self):
         proj = Project.objects.get(slug='pip')
         url = core_tags.make_document_url(proj, 'abc', 'xyz')
         self.assertEqual(url, self.pip_abc_xyz_page_url)
-        url = core_tags.make_document_url(proj, 'abc', 'index.html')
+        url = core_tags.make_document_url(proj, 'abc', 'index', 'index.html')
         self.assertEqual(url, self.pip_abc_url_index)
 
     def test_translation_project_and_version_and_page(self):
         proj = Project.objects.get(slug='pip-fr')
         url = core_tags.make_document_url(proj, 'abc', 'xyz')
         self.assertEqual(url, self.pip_abc_xyz_fr_page_url)
-        url = core_tags.make_document_url(proj, 'abc', 'index.html')
+        url = core_tags.make_document_url(proj, 'abc', 'index', 'index.html')
         self.assertEqual(url, self.pip_abc_fr_url_index)
 
     def test_mkdocs(self):
         proj = Project.objects.get(slug='pip')
-        proj.documentation_type = 'mkdocs'
         url = core_tags.make_document_url(proj, LATEST, 'document')
         self.assertEqual(url, self.pip_latest_document_url)
 
     def test_mkdocs_no_directory_urls(self):
         proj = Project.objects.get(slug='pip')
-        proj.documentation_type = 'mkdocs'
-        url = core_tags.make_document_url(proj, LATEST, 'document.html')
+        url = core_tags.make_document_url(proj, LATEST, 'document', 'document.html')
         self.assertEqual(url, self.pip_latest_document_page_url)
 
     def test_mkdocs_index_no_directory_urls(self):
         proj = Project.objects.get(slug='pip')
-        proj.documentation_type = 'mkdocs'
-        url = core_tags.make_document_url(proj, LATEST, 'index.html')
+        url = core_tags.make_document_url(proj, LATEST, 'index', 'index.html')
         self.assertEqual(url, self.pip_latest_url_index)
 
     def test_restructured_text(self):