conf.py

import json
import os
import sys
import subprocess
from os import getenv
#support for modified code block
from pygments.lexers.shell import BashSessionLexer
from sphinx.highlighting import lexers

sys.path.append(os.path.abspath("./docs/sphinx_ext"))

#############
#
# Add a special lexer to add a class to console lexer
#
#############

def setup(app):
    app.add_css_file("override.css")

class copyAllConsole (BashSessionLexer):
    name = 'ShellSession'

lexers['ShellSession'] = copyAllConsole(startinLine=True)

# Get settings from conf.json

with open('conf.json') as jsonFile:
    conf = json.load(jsonFile)

for item in conf:
    globals()[item] = (conf[item])

# Dynamically determine the major version based on the branch name:
# vx.y for release-x.y, "devel" for everything else
branch = subprocess.check_output("git rev-parse --abbrev-ref HEAD".split(), encoding="utf-8")
if branch.startswith("release-"):
    version = "v" + branch[len("release-"):].strip()
else:
    version = "devel"
release = version

sphinx_md_useGitHubURL = True
baseBranch = "devel"
commitSHA = getenv('GITHUB_SHA')
githubBaseURL = 'https://github.com/' + (getenv('GITHUB_REPOSITORY') or 'intel/pmem-csi') + '/'
githubFileURL = githubBaseURL + "blob/"
githubDirURL = githubBaseURL + "tree/"
if commitSHA:
    githubFileURL = githubFileURL + commitSHA + "/"
    githubDirURL = githubDirURL + commitSHA + "/"
else:
    githubFileURL = githubFileURL + baseBranch + "/"
    githubDirURL = githubDirURL + baseBranch + "/"
sphinx_md_githubFileURL = githubFileURL
sphinx_md_githubDirURL = githubDirURL