Changeset 040b703 in rtems-docs


Ignore:
Timestamp:
Nov 3, 2016, 3:34:40 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, 5, am, master
Children:
64a3db7
Parents:
0bc9c6d
Message:

README: Add host set up and update the build commands.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • README.txt

    r0bc9c6d r040b703  
    77website provides details on doing this.
    88
    9 Building PDF requires a full Latex install.
     9ReST is the Re-Structed-Text format. It is a simple markup language that allows
     10us to create quality documentaion. It is flexible and powerful however do not
     11attempt to train it to create a specific format. You need to test any new way
     12of present something on all output formats. What may look great in one format
     13may not translate with the same clarity to another output format.
     14
     15The RTEMS Documentation output formats are:
     16
     17 HTML        - Multi-page HTML with files in a single directory per manual.
     18 PDF         - Single PDF per manual.
     19 SIngle HTML - Single HTML, one file per manual.
     20
     21Host Setup
     22----------
     23
     24HTML builds directly with Sphinx, PDF requires a full Latex install, and
     25building a Single HTML page requires the 'inliner' tool.
     26
     27Please add your host as you set it up.
     28
     29FreeBSD
     30~~~~~~~
     31
     32Sphinx:
     33  # pkg install py27-sphinx
     34
     35PDF:
     36  # pkg install texlive-full
     37
     38Single HTML:
     39  # pkg install npm
     40  # npm install -g inliner
    1041
    1142Building
     
    1445To build enter in the top directory:
    1546
    16   $ ./waf configure
     47  $ ./waf configure [--pdf] [--singlehtml] [--prefix]
    1748  $ ./waf
    1849
    19 PDF output can be built without needing to configure again:
    20 
    21   $ ./waf --pdf
     50The '--pdf' and '--singlehtml' options can be added to build those output
     51formats.
    2252
    2353To build and install to a specific location:
     
    3161  $ ./waf configure --sphinx-verbose=-v
    3262  $ ./waf clean build
     63
     64You can enter a manual's directory and run the same configure command and build
     65just that manual.
    3366
    3467Documentation Standard
Note: See TracChangeset for help on using the changeset viewer.