summaryrefslogtreecommitdiffstats
path: root/utils/docs-build.sh
AgeCommit message (Collapse)AuthorFilesLines
2016-02-15docs: fix |today|Ryota MIBU1-1/+1
'|today|' in each source files is not replaced since it's put in comment field. This patch fixes this issue by useing 'date' command. Change-Id: Ia7412ebf61463ecd29c976da245fb872d1403189 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-04docs: fix revision hidingRyota MIBU1-1/+1
Revisions have to be in comment, but now it appears due to blank line after '..' directive. Change-Id: I1d1b81eb4545c35156c40cfffe1de21cc9af17a0 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-02docs: hide revision and build date from HTML pagesRyota MIBU1-1/+1
Revisions and build dates are stamped in each source rst files and show up in each HTML pages (Some pages have multiple stamps...). We can see document version in URL path of artifact and those build info by clicking 'Show Source' as well. Let's remove revisions and build dates from HTML pages, but remain in source files so that developers can identify sources. Change-Id: Ibd511137ec17c614c9aa624a7190e7ccfc568b7f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-28Add license headerFatih Degirmenci1-2/+8
License headers are added. - Set company name based on the author who created the file first time - Add SPDX header for Apache 2.0 Change-Id: I8f357a2d6f75179171c681f4b53e0f4249eca5a2 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2016-01-26docs: Change doc8 text to warningFatih Degirmenci1-1/+1
Change-Id: I6d5c79e0f0f33f290bed6eec1a513b455b0aaf0f Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2016-01-25change the document line length longerMatthewLi1-1/+1
JIRA: RELENG-15 Change-Id: Ic31eda0183c0f4f5c954b9e42be7d4edad8e337d Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
2016-01-18docs: fix docs-build.sh for top level documentRyota MIBU1-1/+5
Change-Id: I3465e181c8f6bbb6bc4fbee3d7d3d6162487b9c0 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-12docs: fix ODT document creationRyota MIBU1-2/+7
The command 'pandoc' has to be execute in the document folder, otherwise file path in tex can work. JIRA: RELENG-16 Change-Id: Ia054f6354dceb386805b21721a6736a446980d71 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-08support ODT format creation in docs-build.shRyota MIBU1-0/+15
JIRA: RELENG-16 Change-Id: Iaee8d6947306d0cf3d5e876a757816a2e7786e6f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-07docs-build.sh: fix merging of top level docsRyota MIBU1-1/+10
Change-Id: I6d489be3631fa81e799b55cce9d9e3d1c2608140 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-07fix build directory for OPNFV docsRyota MIBU1-16/+18
Apex has own 'build' directory which is not for docs and contains valid files. This patch fix build dir name from 'build' to 'docs_build' to avoid the conflict. 'output' dir name is also changed to 'docs_output'. Change-Id: I0eb047bfb9c8b85016ce82844915e60538e4d2a8 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-22fix docs-build.sh bug in rst checksRyota MIBU1-9/+12
After [1] merged, docs-build.sh cannot check and edit rst files to add revision into source files. Build error can be found in [2]. This patch fixes this bug. [1] https://gerrit.opnfv.org/gerrit/#/c/4659 [2] https://build.opnfv.org/ci/job/opnfv-docs-verify-master/211/console Change-Id: I506d85341d665a1e2c854ab5965ef3abffa31446 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-22Merge "fix doc-build.sh to support referring to other dirs"Ryota MIBU1-10/+13
2015-12-21Allow doc-build.sh to ignore D000 of doc8Ryota MIBU1-1/+1
http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2015-December/007286.html Change-Id: Icfdb356566918b7d5c55fbf5eb24b4c8570d32f4 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-17fix doc-build.sh to support referring to other dirsRyota MIBU1-10/+13
In [1], we found that current doc-build.sh cannot create document when the main index.rst referring to rst file in another folder. The reason is current script only copies target src folder under the working directory. This patch fix this bug by making doc-build.sh to copy all src files in the original directory structure. Then, all file links (import) can work properly. Error message for '_sha1_' is modified to drop directory info, but developer can find a bad file path from grep output. [1] https://gerrit.opnfv.org/gerrit/#/c/4353 Change-Id: I1d840b8a887306539f97321570f289ac25055a88 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-16update doc-build.sh to allow multiple depth of dirRyota MIBU1-1/+34
In our new documentation guideline, we suggest to create documentation directory just in one depth from top 'docs' directory. This rule can make sure there is no name collision. However, some projects are already using multiple depth of documentation directories. So, let's allow them to create their documents without any namespace collision by creating unique names from directory path. Change-Id: I7806abd00be56b0a4811b3d17216495e11bca825 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-14Adding doc8 check against rst filesRyota MIBU1-0/+22
This patch adds checks for trailing whitespace or length (> 120) in rst files. If there is any violation, the result will be posted on gerrit as jenkins comment, but won't turn the job failed. JIRA: RELENG-26 JIRA: RELENG-27 Change-Id: I9261e3d91921877a95eafe0a650d8da46304ef40 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-30update builder script and how-to-use-docsRyota MIBU1-0/+124
Change-Id: Ia65ebe61c174dc4129d32148d71505c2a2caf480 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>