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

`make_document_url` had a  behavior and it was returning invalid URL
when the `page` argument was a docname (the case when used by the
Embed API endpoint).

This commit consider both cases for this attribute (filename page:
index.html, or document name: config/v2) and decide if the `.html`
extension needs to be added based on the builder
--`documentation_type` (sphinx, sphinx_htmldir, mkdocs, etc) used for
the project.

Author: humitos

readthedocs/core/templatetags/core_tags.py

@@ -38,9 +38,23 @@ def gravatar(email, size=48):
 
 @register.simple_tag(name='doc_url')
 def make_document_url(project, version=None, page=''):
+    """
+    Create a URL for a Project, Version and page.
+
+    ``page`` could be the name of the document as Sphinx call it (e.g.
+    /config-file/v1) (note that the extension is not present) or the filename of
+    the page (e.g. index.html). We need to detect which is the case and add the
+    .html extension when it's a docname.
+    """
     if not project:
         return ''
-    return resolve(project=project, version_slug=version, filename=page)
+
+    if page and not page.endswith('.html'):
+        if project.documentation_type in ('sphinx', 'mkdocs'):
+            page = f'{page}.html'
+
+    path = resolve(project=project, version_slug=version, filename=page)
+    return path
 
 
 @register.filter(is_safe=True)

readthedocs/rtd_tests/tests/test_core_tags.py

@@ -27,8 +27,8 @@ def setUp(self):
         self.pip_abc_url_index = url_base.format(version='/en/abc/index.html')
         self.pip_abc_fr_url = url_base.format(version='/fr/abc/')
         self.pip_abc_fr_url_index = url_base.format(version='/fr/abc/index.html')
-        self.pip_abc_xyz_page_url = url_base.format(version='/en/abc/xyz')
-        self.pip_abc_xyz_fr_page_url = url_base.format(version='/fr/abc/xyz')
+        self.pip_abc_xyz_page_url = url_base.format(version='/en/abc/xyz.html')
+        self.pip_abc_xyz_fr_page_url = url_base.format(version='/fr/abc/xyz.html')
         self.pip_latest_document_url = url_base.format(version='/en/latest/document')
         self.pip_latest_document_page_url = url_base.format(version='/en/latest/document.html')
 
@@ -79,11 +79,26 @@ def test_translation_project_and_version_and_page(self):
         url = core_tags.make_document_url(proj, 'abc', 'index.html')
         self.assertEqual(url, self.pip_abc_fr_url_index)
 
+    def test_sphinx_project_documentation_type(self):
+        proj = Project.objects.get(slug='pip')
+
+        proj.documentation_type = 'sphinx'
+        url = core_tags.make_document_url(proj, LATEST, 'document')
+        self.assertEqual(url, self.pip_latest_document_page_url)
+
+        proj.documentation_type = 'sphinx_htmldir'
+        url = core_tags.make_document_url(proj, LATEST, 'document')
+        self.assertEqual(url, self.pip_latest_document_url)
+
+        proj.documentation_type = 'sphinx_singlehtml'
+        url = core_tags.make_document_url(proj, LATEST, 'document')
+        self.assertEqual(url, self.pip_latest_document_url)
+
     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)
+        self.assertEqual(url, self.pip_latest_document_page_url)
 
     def test_mkdocs_no_directory_urls(self):
         proj = Project.objects.get(slug='pip')