mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Sara Batllori
73 lines
3.0 KiB
Python
73 lines
3.0 KiB
Python
#CHIPSEC: Platform Security Assessment Framework
|
|
#Copyright (c) 2010-2021, Intel Corporation
|
|
#
|
|
#This program is free software; you can redistribute it and/or
|
|
#modify it under the terms of the GNU General Public License
|
|
#as published by the Free Software Foundation; Version 2.
|
|
#
|
|
#This program is distributed in the hope that it will be useful,
|
|
#but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
#GNU General Public License for more details.
|
|
#
|
|
#You should have received a copy of the GNU General Public License
|
|
#along with this program; if not, write to the Free Software
|
|
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
#
|
|
#Contact information:
|
|
#chipsec@intel.com
|
|
#
|
|
|
|
import os
|
|
|
|
doc_path = os.getcwd()
|
|
src_path = os.path.abspath(os.path.join(doc_path, '..', '..'))
|
|
|
|
# Remove subheaders from all rst modules
|
|
def modulesRst():
|
|
for _, _, rstFiles in os.walk(os.path.join(doc_path, 'modules')):
|
|
for file in rstFiles:
|
|
f = open(os.path.join('modules', file), 'r')
|
|
title = f.readline()
|
|
contents = f.read()
|
|
f.close()
|
|
|
|
contents = contents.replace('Submodules\n----------\n\n', '')
|
|
contents = contents.replace('Subpackages\n-----------\n\n', '')
|
|
contents = contents.replace('Module contents\n---------------\n\n', '')
|
|
contents = contents.replace(':show-inheritance:', '')
|
|
contents = contents.replace(':undoc-members:', '')
|
|
contents = contents.replace(':members:', '')
|
|
|
|
f = open(os.path.join('modules', file), 'w')
|
|
f.write(title + contents)
|
|
f.close()
|
|
|
|
# Create rst for xml files
|
|
def xmlRst():
|
|
moduleStr = ''
|
|
for _, _, cfgFiles in os.walk(os.path.join(src_path, 'chipsec', 'cfg', '8086')):
|
|
for cfg in cfgFiles:
|
|
if ".py" not in cfg:
|
|
try:
|
|
with open(os.path.join(src_path, 'chipsec', 'cfg', '8086', cfg), 'r') as f:
|
|
xmlContent = f.read()
|
|
except Exception:
|
|
print(f'\t\tUnable to remove {cfg}!!!')
|
|
else:
|
|
moduleStr += '\tchipsec.cfg.8086.{0}.rst\n'.format(cfg)
|
|
commentBegins = xmlContent.find('<!--')
|
|
commentEnds = xmlContent.find('-->')
|
|
xmlComment = xmlContent[commentBegins+4:commentEnds] + '\n'
|
|
|
|
with open(os.path.join(doc_path, 'modules', 'chipsec.cfg.8086.' + cfg + '.rst'), 'w') as f:
|
|
path = "chipsec\\\\cfg\\\\8086\\\\" + cfg
|
|
f.write( cfg[:-4] + "\n" + "=" *len(cfg) + "\n\n" + "Path: " + path + "\n\n" + xmlComment )
|
|
|
|
with open(os.path.join(doc_path, 'modules', 'chipsec.cfg.8086.rst'), 'w') as f:
|
|
f.write(".. toctree::\n\n" + moduleStr)
|
|
|
|
if __name__ == "__main__":
|
|
modulesRst()
|
|
xmlRst()
|