PELUX Software Factory documentation
Switch branches/tags
Nothing to show
Clone or download
TSAnsari and fhajredini softwarecontainer: fix minor errors in architecture text
Signed-off-by: Tariq Ansari <tansari@luxoft.com>
Latest commit 18fa3e2 Nov 19, 2018

README.md

Software Factory

PELUX Software Factory documentation

Software Factory is maintained at https://github.com/Pelagicore/software-factory

Maintainer: Joakim Gross joakim.gross@pelagicore.com

Dependencies

  • cmake
  • Sphinx
  • plantuml
  • sphinxcontrib-seqdiag
  • sphinxcontrib-blockdiag
  • sphinxcontrib-plantuml
  • sphinxcontrib-actdiag
  • sphinxcontrib-manpage
  • sphinxcontrib-spelling
  • sphinx_rtd_theme
  • texlive-latex-base (when building PDF)
  • texlive-latex-extra (when building PDF)
  • texlive-latex-recommended (when building PDF)

Install build dependencies on Debian

sudo apt-get install cmake python-pip plantuml
sudo pip install sphinxcontrib-seqdiag sphinxcontrib-blockdiag \
    sphinxcontrib-actdiag sphinxcontrib-manpage sphinxcontrib-spelling \
    sphinxcontrib-plantuml sphinx_rtd_theme

Building

The project uses cmake to configure the build. Supported options are:

  • ENABLE_PDF - Enables building the docs in PDF format. Set to OFF by default

Check out the swf-blueprint submodule like so:

    git submodule update --init

Configure and build from the git top dir like so:

    cmake -H. -Bbuild
    cd build
    make

After a successfull build you can find the documentation in build/docs/html/ if you open the index.html in your browser you will see the entry point.

Understanding Spell Check

A spell check is performed during the build step by default. It uses in-built language specific dictionaries and project specific dictionaries (spelling_wordlist.txt) to verify the spellings and causes the build to fail in case of any typos.

The project, which uses this blueprint, should have its own custom dictionary, similar to the one in blueprint (spelling_wordlist.txt). One can supply multiple word lists to the spell-checker plugin, see conf.py.in

The spell checker is added as a custom target, so to run it manually, simply type (after running cmake):

make spelling

To build the docs without checking the spelling, type:

make sphinx-html

License and Copyright

Copyright (C) Pelagicore AB 2017

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

Code and scripts are licensed under LGPL 2.1

SPDX-License-Identifier: CC-BY-SA-4.0