[REF][MOV] documentation apocalypse

Prior to this commit, the Odoo documentation was mainly split between two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...). This was causing several problems among which: - The theme, config, Makefile, and similar technical resources had to be duplicated. This resulted in inconsistent layout, features, and build environments from one documentation to another. - Some pages did not fit either documentation as they were relevant for both users and developers. Some were relevant to neither of the two (e.g., DB management). - Cross-doc references had to be absolute links and they broke often. - Merging large image files in the developer documentation would bloat the odoo/odoo repository. Some contributions had to be lightened to avoid merging too many images (e.g., Odoo development tutorials). - Long-time contributors to the user documentation were chilly about going through the merging process of the developer documentation because of the runbot, mergebot, `odoo-dev` repository, etc. - Some contributors would look for the developer documentation in the `odoo/documentation-user` repository. - Community issues about the user documentation were submitted on the `odoo/odoo` repository and vice-versa. Merging all documentations in one repository will allow us to have one place, one theme, one work process, and one set of tools (build environment, ...) for all of the Odoo docs. As this is a good opportunity to revamp the layout of the documentation, a brand new theme replaces the old one. It features a new way to navigate the documentation, centered on the idea of always letting the reader know what is the context (enclosing section, child pages, page structure ...) of the page they are reading. The previous theme would quickly confuse readers as they navigated the documentation and followed cross-application links. The chance is also taken to get rid of all the technical dangling parts, performance issues, and left-overs. Except for some page-specific JS scripts, the Odoo theme Sphinx extension is re-written from scratch based on the latest Sphinx release to benefit from the improvements and ease future contributions. task-2351938 task-2352371 task-2205684 task-2352544 Closes #945
2021-04-30 12:40:29 +02:00
parent eac5e9f865
commit e3fee2cf46
2471 changed files with 39885 additions and 60126 deletions
@@ -0,0 +1,69 @@
+# Adapted from https://github.com/sphinx-contrib/redirects
+
+import os
+import re
+from pathlib import Path
+
+from sphinx.builders import html as builders
+from sphinx.util import logging as logging
+
+TEMPLATE = '<html><head><meta http-equiv="refresh" content="0; url=%s"/></head></html>'
+
+logger = logging.getLogger(__name__)
+
+def generate_redirects(app):
+    path = os.path.join(app.confdir, app.config.redirects_file)
+    if not os.path.exists(path):
+        logger.warning("Could not find redirects file at '%s'", path)
+        return
+
+    source_suffix = next(iter(app.config.source_suffix))
+
+    if not type(app.builder) == builders.StandaloneHTMLBuilder:
+        logger.info("Redirects are only supported by the 'html' builder. Skipping...")
+        return
+
+    with open(path) as redirects:
+        escaped_source_suffix = source_suffix.replace('.', '\.')
+        pattern = re.compile(
+            r'^[ \t]*([\w\-/]+{0})[ \t]+([\w\-/]+{0})[ \t]*(#.*)?$'.format(escaped_source_suffix)
+        )
+        for line in redirects.readlines():
+            # Exclude comment or empty lines
+            if not line.rstrip() or line.startswith('#'):
+                continue
+
+            match_result = pattern.match(line)
+
+            # Log malformed rules
+            if not match_result:
+                logger.error(
+                    "Ignoring malformed redirection: {0}"
+                    "Please use this format: old_page{1} new_page{1}  # optional comment".format(
+                        line, source_suffix)
+                )
+                continue
+
+            # Parse the rule
+            from_file, to_file, _ = match_result.groups()
+            logger.debug("Redirecting '%s' to '%s'", from_file, to_file)
+
+            # Prepare source and destination paths
+            to_path_prefix = '../' * from_file.count('/')
+            from_html_file = from_file.replace(source_suffix, '.html')
+            to_html_file = to_path_prefix + to_file.replace(source_suffix, '.html')
+            absolute_from_path = Path(app.builder.outdir) / from_html_file
+
+            # Create the redirection
+            absolute_from_path.parent.mkdir(parents=True, exist_ok=True)
+            absolute_from_path.write_text(TEMPLATE % to_html_file)
+
+
+def setup(app):
+    app.add_config_value('redirects_file', 'redirects', 'env')
+    app.connect('builder-inited', generate_redirects)
+
+    return {
+        'parallel_read_safe': False,
+        'parallel_write_safe': True
+    }