Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Look here for https://github.com/simp/simp-doc

Prerequisites:

  • If you're using Fedora or another operating system that comes with Python 3 by default, you will need Python 2.
  • Make sure the following packages are installed and up to date:
    • python-devel

    • sphinx, rst2pdf and other python dependencies. The command below will install them all for you:

      sudo pip install -q -r requirements.txt

HTML Docs

Just install the dependencies and run the following:

$ # builds the html docs
$ rake docs:html

$ # view the html docs on http://localhost:5000
$ rake docs:server

$ builds as a single huge html page
$ rake docs:singlehtml

PDF Docs

It is now recommended that you generate the pdf documentation via the rpm build. Our build process uses mock, an isolated environment, to generate the pdf. It sets up the mock environment for you and will in general be easier than worrying about your actual environment, which can be fragile.

Please use the following few commands to generate an rpm and extract the pdf:

$ rake pkg:rpm[epel-7-x86_64,true]
$ rpm2cpio dist/simp-doc-5.1.0-4.Alpha.noarch.rpm | cpio -t | grep -e '\.pdf'
$ rpm2cpio dist/simp-doc-5.1.0-4.Alpha.noarch.rpm | cpio -ivdm ./usr/share/doc/simp-doc-5.1.0/pdf/<whatever path from above>.pdf

Related articles

  • No labels