Commit Graph

10 Commits

Author SHA1 Message Date
Frinzell, Aaron a42dd4ad6d Remove Mac OS text
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2024-08-26 16:40:43 -07:00
Dan Scott 907009a1d0 Adding back missing lines 2022-05-25 14:28:39 -07:00
Dan Scott 06d2263fd6 Correct list numbering in manual 2022-05-25 14:28:39 -07:00
Frinzell, Aaron eb33b595f3 Python code style guide
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-24 14:06:36 -07:00
Sae86 947ab238a1 Improvements to sphinx
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-10-26 15:05:45 -07:00
Sae86 9281e73532 Update Windows Installation and other improvements
Update win requirements
    Adding info to contact page

Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-06-25 10:16:30 -07:00
Sae86 d52ea51fd7 Sphinx update
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>
2021-03-31 18:40:27 -07:00
Aaron Frinzell 90a220b22c Document sphinx related updates 2020-10-28 09:52:02 -07:00
Erik Bjorge ae3a749101 Documentation updates.
- Updates to install instructions
- Added DAL install instructions
- Other small updates

Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2018-11-11 19:15:00 -08:00
c7zero 82d65590e0 Sphinx sources for chipsec-manual (#185) 2017-04-16 10:31:17 -10:00