File size: 2,534 Bytes
2c3c408 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | #
# This file generates the sidebar/toctree for all TileDB projects and should
# be copied to each project when it is updated.
#
# This file is originally from the RobotPy documentation project
# https://github.com/robotpy/robotpy-docs, licensed under Apache v2.
#
import os
def write_if_changed(fname, contents):
try:
with open(fname, "r") as fp:
old_contents = fp.read()
except:
old_contents = ""
if old_contents != contents:
with open(fname, "w") as fp:
fp.write(contents)
def generate_sidebar(conf, conf_api):
version = conf["rtd_version"]
lines = [
"",
".. DO NOT MODIFY! THIS PAGE IS AUTOGENERATED!",
" To edit the sidebar, modify gensidebar.py and re-build the docs.",
"",
]
url_base = "https://tiledb-inc-tiledb.readthedocs-hosted.com"
lang = "en"
def toctree(name):
lines.extend(
[".. toctree::", " :caption: %s" % name, " :maxdepth: 1", ""]
)
def endl():
lines.append("")
def write(desc, link):
if conf_api == "tiledb":
args = desc, link
else:
args = desc, "%s/%s/%s/%s.html" % (url_base, lang, version, link)
lines.append(" %s <%s>" % args)
def write_api(project, desc, rst_page):
# From non-root project to root project link
if project == "tiledb" and conf_api != "tiledb":
args = desc, url_base, lang, version, rst_page
lines.append(" %s API <%s/%s/%s/%s.html>" % args)
# From anything to non-root project link
elif project != conf_api:
args = desc, url_base, project, lang, version, rst_page
lines.append(" %s API <%s/projects/%s/%s/%s/%s.html>" % args)
# Local project link
else:
args = desc, rst_page
lines.append(" %s API <%s>" % args)
def write_api_url(desc, url):
lines.append(" %s API <%s>" % (desc, url))
#
# Specify the sidebar contents here
#
toctree("API Reference")
write_api("tiledb", "C", "c-api")
write_api("tiledb", "C++", "c++-api")
write_api("tiledb-py", "Python", "python-api")
write_api_url("R", "https://tiledb-inc.github.io/TileDB-R/reference/index.html")
write_api_url("Java", "https://www.javadoc.io/doc/io.tiledb/tiledb-java")
write_api_url("Go", "https://godoc.org/github.com/TileDB-Inc/TileDB-Go")
endl()
write_if_changed("_sidebar.rst.inc", "\n".join(lines))
|