mirror of
https://github.com/chipsec/chipsec
synced 2026-06-08 13:31:00 +00:00
Sae86
d52ea51fd7
Modified:
docs/create_manual.cmd - Add html command and options to build either html or pdf, or both
docs/sphinx/_templates/scover.tmpl - Update date automatically
docs/sphinx/_templates/sstylesheet.style - remove references to templates that will no longer be used, add format styles
docs/sphinx/conf.py - Add several changes for documentation creation. HTML: main doc, copyright year, version and release numbers, html theme options. PDF: increased toc depth
docs/sphinx/index.rst - Update from Home wiki page
docs/sphinx/removeStrRst.py - change how titles are shown and more information shown for modules and add a function to update version in scover
Deleted:
docs/sphinx/_templates/cover.pdf - no longer used
docs/sphinx/_templates/layout.html - no longer used
docs/sphinx/_templates/page.pdf - no longer used
docs/sphinx/_templates/theme.conf - added in conf.py
docs/sphinx/_images/chipsec.jpg - replaced by architecture.png
Replaced by imported wiki files:
docs/sphinx/compandstruct.rst
docs/sphinx/dalinstall.rst
docs/sphinx/description.rst
docs/sphinx/installation.rst
docs/sphinx/linuxinstall.rst
docs/sphinx/mod.rst
docs/sphinx/options.py
docs/sphinx/options.rst
docs/sphinx/osxinstall.rst
docs/sphinx/uefinstall.rst
docs/sphinx/usage.rst
docs/sphinx/winstall.rst
Added
docs/create_manual.sh - Add script version for linux
the following is a list of files imported from the wiki:
docs/sphinx/Architecture-Overview.rst
docs/sphinx/Configuration-Files.rst
docs/sphinx/Developing.rst
docs/sphinx/Install in DAL Win.rst
docs/sphinx/Install in Linux.rst
docs/sphinx/Install in MacOS.rst
docs/sphinx/Install in Windows.rst
docs/sphinx/Interpreting-Results.rst
docs/sphinx/OS-Helpers-and-Drivers.rst
docs/sphinx/Platform-Detection.rst
docs/sphinx/Running-Chipsec.rst
docs/sphinx/USB with UEFI Shell.rst
docs/sphinx/Using-CHIPSEC-with-Kali-Linux.rst
docs/sphinx/Vulnerabilities-and-CHIPSEC-Modules.rst
docs/sphinx/_images/architecture.png
Signed-off-by: Sae86 <sae.batllori@intel.com>
50 lines
1.3 KiB
Batchfile
50 lines
1.3 KiB
Batchfile
@echo off
|
|
if "%1" == "" goto usage
|
|
set TARGET=%1
|
|
|
|
echo "************************ BUILDING DOCUMENTATION ******************************"
|
|
|
|
pushd %TARGET%\docs\sphinx
|
|
|
|
call sphinx-apidoc -e -f -T -o modules -d 99 %TARGET%
|
|
call python removeStrRst.py
|
|
|
|
:: Clean up files that we do not want to process into documenation
|
|
del .\modules\chipsec_tools.*
|
|
del .\modules\tests.*
|
|
del .\modules\setup.rst
|
|
del .\modules\chipsec.rst
|
|
del .\modules\chipsec.cfg.rst
|
|
del .\modules\chipsec.chipset.rst
|
|
del .\modules\chipsec.command.rst
|
|
del .\modules\chipsec.defines.rst
|
|
del .\modules\chipsec.file.rst
|
|
del .\modules\chipsec.logger.rst
|
|
del .\modules\chipsec.module.rst
|
|
del .\modules\chipsec.module_common.rst
|
|
del .\modules\chipsec.result_deltas.rst
|
|
del .\modules\chipsec.testcase.rst
|
|
del .\modules\chipsec_main.rst
|
|
del .\modules\chipsec_util.rst
|
|
|
|
:: create chipsec-manual.pdf
|
|
if "%2" == "pdf" call sphinx-build -b pdf -T . %TARGET%
|
|
if "%2" == "html" call sphinx-build -b html -T . %TARGET%\manual
|
|
:: create chipsec-manual.pdf and html pages
|
|
if "%2" == "" (
|
|
call sphinx-build -b pdf -T . %TARGET%
|
|
call sphinx-build -b html -T . %TARGET%\manual
|
|
)
|
|
popd
|
|
|
|
:: remove sphinx folder
|
|
pushd %TARGET%
|
|
rmdir /s /q %TARGET%\.doctrees
|
|
popd
|
|
|
|
goto end
|
|
|
|
:usage
|
|
echo Usage: create_manual.cmd [CHIPSEC_PATH] [type] type - pdf, html or empty (both)
|
|
|
|
:end |