lt1201 / simp-doc Goto Github PK

• SIMP Documentation
• Usage
  • Building the docs
  • Maintaining the data
• Environment variables
  • SIMP_CORE_PATH
  • SIMP_BRANCH
• Managing Sphinx prerequisites with pip

The repository for the SIMP documentation.

It is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet.

If you find any issues, they can be submitted to our JIRA.

Please read our Contribution Guide and visit our developer wiki.

# build HTML docs, dumps the resulting files in doc/;
rake docs:html

# build HTML docs, specifying a local simp-core location
SIMP_CORE_PATH=<path to local simp-core git repo> rake docs:html

# build HTML docs for a specific SIMP version, as specified by a
# tag/branch
SIMP_BRANCH='6.0.0-0' rake docs:html

# run a local web server to view HTML docs on http://localhost:5000
rake docs:server[port]

If you want to build the RPM on EL6 systems, you will need to ensure that the SCL and python versions are appropriately available using the following repositories and check the RPM spec file for the relevant required packages.

[centos-sclo-sclo]
name=CentOS-6 - SCLo sclo
baseurl=http://mirror.centos.org/centos/6/sclo/$basearch/sclo/
gpgcheck=1
enabled=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-SIG-SCLo

[centos-sclo-rh]
name=CentOS-6 - SCLo rh
baseurl=http://mirror.centos.org/centos/6/sclo/$basearch/rh/
gpgcheck=1
enabled=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-SIG-SCLo

[extras]
name=CentOS-$releasever - Extras
baseurl=http://mirror.centos.org/centos/$releasever/extras/$basearch/
gpgcheck=1
gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-6

# Update the RPM lists
rake docs:rpm:external

# Update the SIMP RPM list
rake docs:rpm:simp

Sets an path to a local simp-core git repository. Can be used to test new revisions of the simp-core Changelog.rst. This defaults to ../.. under the assumption that this repository has been checked out as part of the simp-core SIMP ISO build.

SIMP_CORE_PATH=$PWD/../simp-core rake docs:html

Sets the simp-core github tag/branch for the version of docs to build, when a local simp-core repository is not to be used. The version, release, and changelog information will be downloaded for that version to build the docs. This defaults to master.

SIMP_BRANCH=6.0.0-1 rake docs:html

CAUTION: This branch is used only to determine version information. It does not result in the simp-docs version that corresponds to SIMP_BRANCH to be downloaded and built.

If you are using PyPi to manage python packages, you may need to run something like the following:

# simp install
sudo pip install -q -r requirements.txt

# upgrading (needed in some cases when rst2pdf prereqs get stuck)
sudo pip install --upgrade --force-reinstall  -r requirements.txt -v

The prerequisites for rst2pdf may require extra OS packages:

# fedora 24
sudo dnf install -y libjpeg-devel zlib-devel python-devel

# centos 7
sudo yum install -y libjpeg-devel zlib-devel python-devel

# Debian 8.5 (containers)
sudo apt-get install -y python-dev zlib1g-dev libjpeg-dev