mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-22 03:32:04 +00:00
1a35edf971
Check in the initial pages that are generated from the pods Once these are in, will look into how to autopush changes from the xCAT build scripts when POD files are changed. This seems to be the quickest way to get the man pages into the documentaion at this point.
59 lines
2.0 KiB
Python
Executable File
59 lines
2.0 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
import glob
|
|
import os
|
|
import sys
|
|
import subprocess
|
|
|
|
#TODO: Delete the old files to support removing a man page
|
|
|
|
def cmd_exists(cmd):
|
|
return subprocess.call("type " + cmd, shell=True,
|
|
stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0
|
|
|
|
if not cmd_exists("pod2rst"):
|
|
print "ERROR, %s requires pod2rst to continue!" %(os.path.basename(__file__))
|
|
sys.exit(1)
|
|
|
|
# the location relativate to xcat-core where the man pages will go
|
|
MANPAGE_DEST="./docs/source/guides/admin-guides/references/man"
|
|
|
|
# List the xCAT component directory which contain pod pages
|
|
COMPONENTS = ['xCAT-SoftLayer', 'xCAT-test', 'xCAT-client', 'xCAT-vlan']
|
|
|
|
for component in COMPONENTS:
|
|
for root,dirs,files in os.walk("%s" %(component)):
|
|
|
|
for file in files:
|
|
# only interested in .pod files
|
|
if file.endswith(".pod"):
|
|
pod_input = os.path.join(root,file)
|
|
|
|
filename = os.path.basename(pod_input)
|
|
# get the man version (1,3,5,8,etc)
|
|
man_ver = filename.split('.')[1]
|
|
# title is needed to pass to pod2rst
|
|
title = filename.split('.')[0]
|
|
|
|
#
|
|
# Wanted to have DESTINATION contain the man version,
|
|
# but we currently have man1,man3,man5,man8, etc in
|
|
# the .gitignore file. Need to fix Ubuntu builds
|
|
#
|
|
# DESTINATION = "%s%s" %(MANPAGE_DEST, man_ver)
|
|
#
|
|
DESTINATION = "%s" %(MANPAGE_DEST)
|
|
try:
|
|
os.stat(DESTINATION)
|
|
except:
|
|
# Create the directory if it does not exist
|
|
os.mkdir(DESTINATION)
|
|
|
|
outputFile = filename.replace("pod", "rst")
|
|
rst_output = "%s/%s" %(DESTINATION, outputFile)
|
|
|
|
# generate the pod2rst command
|
|
cmd = "pod2rst --infile=%s --outfile=%s --title=%s.%s" %(pod_input, rst_output, title, man_ver)
|
|
print cmd
|
|
os.system(cmd)
|