kopia lustrzana https://github.com/deathbeds/ipydrawio
149 wiersze
3.8 KiB
Python
149 wiersze
3.8 KiB
Python
"""ReadTheDocs-compatible sphinx configuration"""
|
|
# Copyright 2022 ipydrawio contributors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import datetime
|
|
import json
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
from sphinx.application import Sphinx
|
|
|
|
HERE = Path(__file__).parent
|
|
RTD = json.loads(os.environ.get("READTHEDOCS", "False").lower())
|
|
|
|
sys.path += [str(HERE / "vendor")]
|
|
|
|
ROOT = HERE.parent
|
|
APP_PKG = ROOT / "packages/ipydrawio/package.json"
|
|
APP_DATA = json.loads(APP_PKG.read_text(encoding="utf-8"))
|
|
RTD = json.loads(os.environ.get("READTHEDOCS", "False").lower())
|
|
RTD_TASKS = [
|
|
"build",
|
|
"setup:pip:check",
|
|
"docs:typedoc:mystify",
|
|
"demo:stage*",
|
|
"demo",
|
|
]
|
|
|
|
# metadata
|
|
author = APP_DATA["author"]
|
|
project = author.replace("Contributors", "").strip()
|
|
copyright = f"{datetime.date.today().year}, {author}"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = APP_DATA["version"]
|
|
|
|
# The short X.Y version
|
|
version = ".".join(release.rsplit(".", 1))
|
|
|
|
# sphinx config
|
|
extensions = [
|
|
"myst_nb",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.autodoc",
|
|
# for routing
|
|
"sphinxext.rediraffe",
|
|
"sphinx-jsonschema",
|
|
"autodoc_traits",
|
|
]
|
|
|
|
autosectionlabel_prefix_document = True
|
|
myst_heading_anchors = 3
|
|
suppress_warnings = ["autosectionlabel.*"]
|
|
|
|
rediraffe_redirects = {
|
|
"demo/index": "_static/lab/index",
|
|
"demo/retro/index": "_static/retro/tree/index",
|
|
}
|
|
|
|
# files
|
|
templates_path = ["_templates"]
|
|
html_favicon = "_static/favicon.ico"
|
|
html_static_path = ["_static", "../build/demo"]
|
|
exclude_patterns = [
|
|
".ipynb_checkpoints",
|
|
"**/.ipynb_checkpoints",
|
|
"**/~.*",
|
|
"**/node_modules",
|
|
"babel.config.*",
|
|
"jest-setup.js",
|
|
"jest.config.js",
|
|
"test/",
|
|
"tsconfig.*",
|
|
"webpack.config.*",
|
|
]
|
|
html_css_files = [
|
|
"theme.css",
|
|
]
|
|
|
|
# theme
|
|
html_theme = "pydata_sphinx_theme"
|
|
html_logo = "_static/logo.svg"
|
|
html_theme_options = {
|
|
"github_url": APP_DATA["repository"]["url"],
|
|
"use_edit_page_button": True,
|
|
# "navbar_start": ["navbar-logo.html", "launch.html"],
|
|
}
|
|
html_sidebars = {
|
|
"**": [
|
|
"demo.html",
|
|
"search-field.html",
|
|
"sidebar-nav-bs.html",
|
|
"sidebar-ethical-ads.html",
|
|
]
|
|
}
|
|
|
|
html_context = {
|
|
"github_user": "deathbeds",
|
|
"github_repo": "ipydrawio",
|
|
"github_version": "master",
|
|
"doc_path": "docs",
|
|
"demo_tarball": f"_static/ipydrawio-lite-{release}.tgz",
|
|
}
|
|
|
|
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"traitlets": ("https://traitlets.readthedocs.io/en/stable/", None),
|
|
"ipywidgets": ("https://ipywidgets.readthedocs.io/en/stable/", None),
|
|
}
|
|
|
|
|
|
def clean_schema(app: Sphinx, error):
|
|
if error:
|
|
return
|
|
for schema_html in Path(app.builder.outdir).glob("api/schema.html"):
|
|
text = schema_html.read_text(encoding="utf-8")
|
|
new_text = re.sub(r'<span id="([^"]*)"></span>', "", text)
|
|
if text != new_text:
|
|
schema_html.write_text(new_text, encoding="utf-8")
|
|
|
|
|
|
def before_rtd_build(app: Sphinx, error):
|
|
"""performs the full frontend build, and ensures the typedoc"""
|
|
for task in RTD_TASKS:
|
|
print(f"running doit {task}", flush=True)
|
|
subprocess.check_call(["doit", task], cwd=str(ROOT))
|
|
|
|
|
|
def setup(app):
|
|
app.connect("build-finished", clean_schema)
|
|
if RTD:
|
|
app.connect("config-inited", before_rtd_build)
|