blob: 07b165bae67746de09ff9e0056cf825ce9ceca92 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
---
edit_link: ''
title: Usage
origin_url: >-
https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/docs/handle-docs/documentation-usage.md
---
<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/howto/master/howto-add-docs-handle-docs-book.yml -->
# Documentation Usage
The [docs-webtemplate](https://github.com/automotive-grade-linux/docs-webtemplate)
repository contains AGL documentation website template, rendering is visible at
<https://docs.automotivelinux.org.>
This website relies on the generator located in
[docs-tools](https://github.com/automotive-grade-linux/docs-tools).
## Download Sources
Get the ```setupdocs.sh``` script to initialize your environment.
```bash
wget https://raw.githubusercontent.com/automotive-grade-linux/docs-webtemplate/master/setupdocs.sh
```
This script fetches [docs-tools](https://github.com/automotive-grade-linux/docs-tools), install npm modules.
```bash
mkdir docs-webtemplate
bash setupdocs.sh --directory=docs-webtemplate
```
For consulting help, do:
```bash
bash setupdocs.sh --help
```
## Building a local site
In docs-webtemplate directory:
```bash
make serve
```
For cleaning your work, use:
```bash
make clean
```
## Documentation from local repositories
It is also possible to use markdown files from local repositories.
For local fetch, a specific file named ```__fetched_files_local.yml```
was introduced.
This file is used to overload ```url_fetch``` in section_<version>.yml
in order to use local repositories on not remote ones.
Thus, this file is needed to be added in the docs-webtemplate root,
see an example below:
```bash
############__fetched_files_local.yml##############
-
url_fetch : <pathToDocsSources>/docs-sources/
git_name : automotive-grade-linux/docs-sources
-
url_fetch : <pathToXdsDocs>/xds-docs/
git_name : src/xds/xds-docs
-
git_name: AGL/meta-renesas-rcar-gen3
url_fetch: <pathToMetaRenesas>/meta-renesas-rcar-gen3
###################################################
```
It is also possible to use ```id``` instead of ```git_name```.
## Test Hyperlinks
[LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to check all the hyperlinks in the site.
For testing hyperlinks as soon as the local site is running, do:
```bash
make linkchecker
```
or
```bash
linkchecker http://localhost:4000
```
The ```linkchecker``` output will display the broken link and there location
in the site.
|
