Merge pull request #1176 from cmavr8/docs-man-building
Minor typo fixing in doc building
This commit is contained in:
commit
f93c398ba0
|
@ -3,7 +3,7 @@
|
|||
filename=Manual
|
||||
doc_files=(
|
||||
'Introduction.md'
|
||||
'Getting Started.md'
|
||||
'Getting Started.md'
|
||||
'Safety.md'
|
||||
'Installation.md'
|
||||
'Configuration.md'
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
#Building Manual.
|
||||
|
||||
The manual PDF file is generated by concatenating relevant markdown files and by transforming the result using Gimli to obtain the final PDF file. This steps are handled automatically by the ```build_manual.sh``` script located in the root of the repository next to the Makefile.
|
||||
The manual PDF file is generated by concatenating relevant markdown files and by transforming the result using Gimli to obtain the final PDF file. This steps are handled automatically by the ```build_docs.sh``` script located in the root of the repository next to the Makefile.
|
||||
|
||||
##Requrements & Installation
|
||||
The PDF manual generation uses the Gimli for the conversion. It can be installed via ruby gems. On Debian based systems the installation steps are:
|
||||
```bash
|
||||
sudo apt-get install ruby1.9.1 ruby1.9.1-dev rubygems zlib1g-dev wkhtmltopdf libxml2-dev libxslt-dev
|
||||
sudo sudo gem1.9.1 install gimli
|
||||
sudo gem1.9.1 install gimli
|
||||
```
|
||||
|
||||
##Configuration
|
||||
|
@ -17,4 +17,4 @@ doc_files=( 'Configuration.md'
|
|||
'...'
|
||||
'...'
|
||||
)
|
||||
```
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue