Skip to content
Documentation for the Scava project
Branch: master
Clone or download
Latest commit c90e8b9 May 23, 2019

README.md

Welcome to the Scava documentation

This repository contains all the documentation pertaining to the Eclipse Scava project.

Documentation Status

The documentation system used for Scava relies on Markdown files, stored in the docs/ directory. These can be converted to a full static web site using mkdocs. The configured output directory for html files is site/, which can then be served directly by any web server.

There are two intended deployment sites:

Building the web site

Simply execute the following command at the root of the directory.

boris@kadath:gh_crossminer_scava-docs$ mkdocs build --clean
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/boris/Projects/gh_crossminer_scava-docs/site
boris@kadath:gh_crossminer_scava-docs$

About Scava

You can’t perform that action at this time.