aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2018-11-09[docs] Transition to local docs build job.Emma Foley1-0/+17
Docs builds have transitioned to using local build jobs. This allows Yardstick docs to be built and verified locally. The time taken to build and verify docs in the gate for new changes should be reduced, as the docs for each project will be built separately. This change also allow contributers to test their docs builds locally, using tox:: tox -e docs tox -e docs-linkcheck TODO: Update the dev guide to include new tox environment Related: DOCS-191 JIRA: YARDSTICK-1415 Signed-off-by: Emma Foley <emma.l.foley@intel.com> Change-Id: Ib8bab85475dcd5127a2c41a2d55dce8f8d9da574 (cherry picked from commit 7203ff5925b805d07a5df53b6cdcf7d44cc4e4d1)
2015-12-16Adapt documentation to latest guidelinesAna C1-52/+0
Adapt Yardstick documentation according to the latest guidelines from the Releng project. The only change in test case description TC001 and TC002 is to remove logo. The same for the test case description v2 template. The previous version of test case description is deleted from repo. The Yardstick_task_template is edited to keep line lenght 80 char. This commit also adds index for docs/yardstick and for docs/user_guides/framework. The overview for the vTC .rst file has been fixed to enable the .pdf generation. Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-12-03Remove etc and source folder from yardstick documentationFatih Degirmenci1-0/+52
conf.py and logo will come from releng which is common for all projects. The directory structure in docs folder has not been decided yet so this change does not require you to change your current way of working. Once this directory structure is decided by opnfvdocs and releng, the changes need to be reflected back to all projects, including yardstick. Change-Id: If0558474a819f4a44e34f790d26c5486751b8266 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>