corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1693140 - Fix the mermaid rendering issue and remove post processing script.r=sylvestre DONTBUILD

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D105674
This commit is contained in:
championshuttler
2021-02-19 08:45:10 +00:00
parent 8f7f9ba090
commit 029e008b15
2 changed files with 1 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/conf.py
View File

@@ -74,6 +74,7 @@ html_logo = os.path.join(
topsrcdir, "browser/branding/nightly/content/firefox-wordmark.svg" topsrcdir, "browser/branding/nightly/content/firefox-wordmark.svg"
) )
html_favicon = os.path.join(topsrcdir, "browser/branding/nightly/firefox.ico") html_favicon = os.path.join(topsrcdir, "browser/branding/nightly/firefox.ico")
html_js_files = ["https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.9.1/mermaid.js"]
exclude_patterns = ["_build", "_staging", "_venv"] exclude_patterns = ["_build", "_staging", "_venv"]
pygments_style = "sphinx" pygments_style = "sphinx"

34
tools/moztreedocs/mach_commands.py
View File

@@ -8,7 +8,6 @@ from __future__ import absolute_import, print_function, unicode_literals
import fnmatch import fnmatch
import multiprocessing import multiprocessing
import os import os
import re
import subprocess import subprocess
import sys import sys
import time import time
@@ -166,9 +165,6 @@ class Documentation(MachCommandBase):
else: else:
print("\nGenerated documentation:\n%s" % savedir) print("\nGenerated documentation:\n%s" % savedir)
print("Post processing HTML files")
self._post_process_html(savedir)
# Upload the artifact containing the link to S3 # Upload the artifact containing the link to S3
# This would be used by code-review to post the link to Phabricator # This would be used by code-review to post the link to Phabricator
if write_url is not None: if write_url is not None:
@@ -263,36 +259,6 @@ class Documentation(MachCommandBase):
print(args) print(args)
return sphinx.cmd.build.build_main(args) return sphinx.cmd.build.build_main(args)
def _post_process_html(self, savedir):
"""
Perform some operations on the generated html to fix some URL
"""
MERMAID_VERSION = "8.4.4"
for root, _, files in os.walk(savedir):
for file in files:
if file.endswith(".html"):
p = os.path.join(root, file)
with open(p, "r", encoding="utf_8") as file:
filedata = file.read()
# Workaround https://bugzilla.mozilla.org/show_bug.cgi?id=1607143
# to avoid a CSP error
# This method should be removed once
# https://github.com/mgaitan/sphinxcontrib-mermaid/pull/37 is merged
# As sphinx-mermaid currently uses an old version, also force
# a more recent version
filedata = re.sub(
r"https://unpkg.com/mermaid@.*/dist",
r"https://cdnjs.cloudflare.com/ajax/libs/mermaid/{}".format(
MERMAID_VERSION
),
filedata,
)
with open(p, "w", encoding="utf_8") as file:
file.write(filedata)
@property @property
def manager(self): def manager(self):
if not self._manager: if not self._manager: