diff options
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | contain/tocs/apis_services/fetched_files.yml (renamed from site/_tocs/apis_services/fetched_files.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/apis_services/toc_dev_en.yml (renamed from site/_tocs/apis_services/toc_dev_en.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/architecture/fetched_files.yml (renamed from site/_tocs/architecture/fetched_files.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/architecture/toc_dev_en.yml (renamed from site/_tocs/architecture/toc_dev_en.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/devguides/fetched_files.yml (renamed from site/_tocs/devguides/fetched_files.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/devguides/toc_dev_en.yml (renamed from site/_tocs/devguides/toc_dev_en.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/getting_started/fetched_files.yml (renamed from site/_tocs/getting_started/fetched_files.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/getting_started/toc_dev_en.yml (renamed from site/_tocs/getting_started/toc_dev_en.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/hardware/fetched_files.yml (renamed from site/_tocs/hardware/fetched_files.yml) | 0 | ||||
| -rw-r--r-- | contain/tocs/hardware/toc_dev_en.yml (renamed from site/_tocs/hardware/toc_dev_en.yml) | 0 |
12 files changed, 5 insertions, 17 deletions
@@ -22,12 +22,12 @@ clean: rm -f $(FETCHTS) rm -f $(LOCALFETCH) -$(LOCALFETCH): $(wildcard site/_tocs/*/fetched_files.yml) +$(LOCALFETCH): $(wildcard contain/toc/*/fetched_files.yml) $(DOCBUILD) $(VERBOSE) --localFetch --fetch --force touch $(FETCHTS) touch $@ -$(FETCHTS): $(wildcard site/_tocs/*/fetched_files.yml) +$(FETCHTS): $(wildcard contain/toc/*/fetched_files.yml) $(DOCBUILD) $(VERBOSE) $(LOCAL_FETCHTS) --fetch --force touch $@ @@ -20,7 +20,7 @@ Other configuration files in conf/ starting by an underscore (_) are used by Jek ## generate a 1st site from your template ``` ../doctools/webdocs/docbuild --clean # deleted all generated file if any - ../doctools/webdocs/docbuild --fetch [--force] # collect doc from github (fetch list in site/_tocs/*/fetch_files.yml) + ../doctools/webdocs/docbuild --fetch [--force] # collect doc from github (fetch list in contain/toc/*/fetch_files.yml) ../doctools/webdocs/docbuild --build --serve --watch --incremental # build config/tocs, generate html and start a local webserver xdg-open http://localhost:4000 @@ -31,6 +31,7 @@ Other configuration files in conf/ starting by an underscore (_) are used by Jek Alternatively, a Makefile can be used and defines the most common operations: ``` make fetch + make localFetch make build make push make serve @@ -43,25 +44,12 @@ Alternatively, a Makefile can be used and defines the most common operations: - site/* directories not prefixed with "_" represent en entry within the menu - site/_* directories contain template, configuration, options used by Jekyll - site/_data is a special directory that hold both static and generated files to adjust page/site values within html pages -- site/_tocs/*/toc_VERSION_LANGUAGE.yml TOC(TableOfContent) and Fetch definitions +- contain/toc/*/toc_VERSION_LANGUAGE.yml TOC(TableOfContent) and Fetch definitions - site/_layouts and site/_includes holds page template - site/static holds assets (static images, CSS etc.) - register at https://community.algolia.com/docsearch/ and update your apikey into conf/_config.yml -## trick - -- For the moment you can only build source documentation from github (automotive-grade-linux/docs-agl). -So if you want to test localy your modification before a "pull request", just change github path with: - -``` -export MY_GITHUB_ACCOUNT=XXX -find ../ -name fetched_files.yml -exec sed -i "s@automotive-grade-linux/docs-agl@$MY_GITHUB_ACCOUNT/docs-agl@g" {} \; -make clean; -make fetch; -make build; -make serve; -``` ## bugs diff --git a/site/_tocs/apis_services/fetched_files.yml b/contain/tocs/apis_services/fetched_files.yml index 91caa02..91caa02 100644 --- a/site/_tocs/apis_services/fetched_files.yml +++ b/contain/tocs/apis_services/fetched_files.yml diff --git a/site/_tocs/apis_services/toc_dev_en.yml b/contain/tocs/apis_services/toc_dev_en.yml index 9545874..9545874 100644 --- a/site/_tocs/apis_services/toc_dev_en.yml +++ b/contain/tocs/apis_services/toc_dev_en.yml diff --git a/site/_tocs/architecture/fetched_files.yml b/contain/tocs/architecture/fetched_files.yml index 8ca29b3..8ca29b3 100644 --- a/site/_tocs/architecture/fetched_files.yml +++ b/contain/tocs/architecture/fetched_files.yml diff --git a/site/_tocs/architecture/toc_dev_en.yml b/contain/tocs/architecture/toc_dev_en.yml index 6d8e2d9..6d8e2d9 100644 --- a/site/_tocs/architecture/toc_dev_en.yml +++ b/contain/tocs/architecture/toc_dev_en.yml diff --git a/site/_tocs/devguides/fetched_files.yml b/contain/tocs/devguides/fetched_files.yml index e373840..e373840 100644 --- a/site/_tocs/devguides/fetched_files.yml +++ b/contain/tocs/devguides/fetched_files.yml diff --git a/site/_tocs/devguides/toc_dev_en.yml b/contain/tocs/devguides/toc_dev_en.yml index 6d9b419..6d9b419 100644 --- a/site/_tocs/devguides/toc_dev_en.yml +++ b/contain/tocs/devguides/toc_dev_en.yml diff --git a/site/_tocs/getting_started/fetched_files.yml b/contain/tocs/getting_started/fetched_files.yml index 1de9126..1de9126 100644 --- a/site/_tocs/getting_started/fetched_files.yml +++ b/contain/tocs/getting_started/fetched_files.yml diff --git a/site/_tocs/getting_started/toc_dev_en.yml b/contain/tocs/getting_started/toc_dev_en.yml index 9835826..9835826 100644 --- a/site/_tocs/getting_started/toc_dev_en.yml +++ b/contain/tocs/getting_started/toc_dev_en.yml diff --git a/site/_tocs/hardware/fetched_files.yml b/contain/tocs/hardware/fetched_files.yml index 62b1c0d..62b1c0d 100644 --- a/site/_tocs/hardware/fetched_files.yml +++ b/contain/tocs/hardware/fetched_files.yml diff --git a/site/_tocs/hardware/toc_dev_en.yml b/contain/tocs/hardware/toc_dev_en.yml index 0c6b9a5..0c6b9a5 100644 --- a/site/_tocs/hardware/toc_dev_en.yml +++ b/contain/tocs/hardware/toc_dev_en.yml |