Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate code style to Black

Browse Source
This commit is contained in:
Nick Hall
2023-07-31 14:40:59 +01:00
parent 6cb4380d01
commit 41720c5a7e
1109 changed files with 91319 additions and 67252 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
docs/update_doc.py
View File

@ -37,18 +37,19 @@ import sys
from argparse import ArgumentParser
# You can set these variables from the command line.
SPHINXBUILD = 'sphinx-build'
SPHINXBUILD = "sphinx-build"
if sys.platform == 'win32':
pythonCmd = os.path.join(sys.prefix, 'bin', 'python.exe')
sphinxCmd = os.path.join(sys.prefix, 'bin', 'sphinx-build.exe')
elif sys.platform in ['linux', 'linux2', 'darwin', 'cygwin']:
pythonCmd = os.path.join(sys.prefix, 'bin', 'python')
if sys.platform == "win32":
pythonCmd = os.path.join(sys.prefix, "bin", "python.exe")
sphinxCmd = os.path.join(sys.prefix, "bin", "sphinx-build.exe")
elif sys.platform in ["linux", "linux2", "darwin", "cygwin"]:
pythonCmd = os.path.join(sys.prefix, "bin", "python")
sphinxCmd = SPHINXBUILD
else:
print ("Update Docs ERROR: unknown system, don't know sphinx, ... commands")
print("Update Docs ERROR: unknown system, don't know sphinx, ... commands")
sys.exit(0)
def tests():
"""
Testing installed programs.
@ -57,15 +58,16 @@ def tests():
"""
try:
print("\n=================='python'=============================\n")
os.system('''%(program)s -V''' % {'program': pythonCmd})
os.system("""%(program)s -V""" % {"program": pythonCmd})
except:
print ('Please, install python')
print("Please, install python")
try:
print("\n=================='sphinx-build'=============================\n")
os.system('''%(program)s''' % {'program': sphinxCmd})
os.system("""%(program)s""" % {"program": sphinxCmd})
except:
print ('Please, install sphinx')
print("Please, install sphinx")
def main():
"""
@ -74,17 +76,26 @@ def main():
"""
parser = ArgumentParser(
description='This program aims to handle manual'
' and translated version.',
)
description="This program aims to handle manual" " and translated version.",
)
parser.add_argument("-t", "--test",
action="store_true", dest="test", default=True,
help="test if 'python' and 'sphinx' are properly installed")
parser.add_argument(
"-t",
"--test",
action="store_true",
dest="test",
default=True,
help="test if 'python' and 'sphinx' are properly installed",
)
parser.add_argument("-b", "--build",
action="store_true", dest="build", default=True,
help="build documentation")
parser.add_argument(
"-b",
"--build",
action="store_true",
dest="build",
default=True,
help="build documentation",
)
args = parser.parse_args()
@ -94,6 +105,7 @@ def main():
if args.build:
build()
def build():
"""
Build documentation.
@ -101,10 +113,11 @@ def build():
# testing stage
os.system('''%(program)s -b html . _build/html''' % {'program': sphinxCmd})
#os.system('''%(program)s -b changes . _build/changes''' % {'program': sphinxCmd})
#os.system('''%(program)s -b linkcheck . _build/linkcheck''' % {'program': sphinxCmd})
#os.system('''%(program)s -b devhelp . _build/devhelp''' % {'program': sphinxCmd})
os.system("""%(program)s -b html . _build/html""" % {"program": sphinxCmd})
# os.system('''%(program)s -b changes . _build/changes''' % {'program': sphinxCmd})
# os.system('''%(program)s -b linkcheck . _build/linkcheck''' % {'program': sphinxCmd})
# os.system('''%(program)s -b devhelp . _build/devhelp''' % {'program': sphinxCmd})
if __name__ == "__main__":
main()