summaryrefslogtreecommitdiffstats
path: root/etc
AgeCommit message (Collapse)AuthorFilesLines
2018-10-29Bump Sphinx version to 1.5.6Aric Gardner1-1/+1
1.5.6 allows: intersphinx link using the ':doc:' directive. And does not have the memory leak that was causing our build to fail found in sphinx-build 1.6 onwards Change-Id: I1a04871b2771a0123096629d706a6b2d375f520e Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-10-29Revert "Bump Sphinx version to 1.7.9"Trevor Bramwell1-1/+1
A change between 1.3 and 1.7.9 introduced a memory leak which is causing our builds to take >3Gb of memory. Reverting this until we can track down the issue. This reverts commit f0c78d7f71fa697d0722c9f320e7ea2f72fdeaae. Change-Id: Ib8a8ad5840d95ca98b579b333b7263a07f9843a2 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-19Bump Sphinx version to 1.7.9Trevor Bramwell1-1/+1
The docs project has been working off of an old version for quite some time. Bumping the Sphinx version allows us to intersphinx link using the ':doc:' directive. Change-Id: Ic0782ec3c29778195d580107212427382eb51b1c Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-07-19Bypass assertion bug by downgrading docutilsTrevor Bramwell1-1/+1
There is a bug in docutils which causes it to break on remote images, as discovered by OpenStack: https://sourceforge.net/p/docutils/bugs/301/ Change-Id: Id1ae986c255d1d0df38812dc02ac443eed198103 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-01-27New Tox build scriptShubhamRathi1-0/+1
To keep the doc jobs for OPNFV & ODL as similar as possible, we're using a similar tox build script as used in ODLDocs. The new merge job is tested to run the same tox build script. This build script is to be run as `tox -edocs`. Everything under docs/ shall be built. Change-Id: Ic4fab5e431e6937a1dbbeca2b1ff339dd092b688 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-09Requirement updated to support sphinx_bootstrap_themeShubhamRathi1-0/+1
Builds for the new conf.py's importing sphinx_bootstrap_theme (SBT) were failing because jenkins was still loading the previous version of requirements which did not have SBT. Adding the SBT to requirements will ensure the build does not fail. Change-Id: I9a46f519f5d5548e3a304a7d55d99e80a4366460 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2016-09-05Removing excess License info.ChristopherPrice1-1/+0
Removed License info from the sidebar, on review it is not necessary. Change-Id: I12c7a4d4c6ec7498462e99e953867ba64630858b Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-01Adding creative commons license info.ChristopherPrice1-0/+1
Cannot build a reference until it's merged I guess, Ryota can you make sure this is not broken? Change-Id: Ibc7d98287cb513b894ae79f53864f654959de39a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-08-11add version, builddate and copyright in sidebarRyota MIBU1-0/+3
Change-Id: I652de718ebc1084230499eb7bc19e2fd9ab90159 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11remove 'Save to PDF' link from normal HTML pagesRyota MIBU1-1/+3
'Save to PDF' should be appeared in single HTML pages. JIRA: DOCS-156 Change-Id: I4566a976a8590a521bff4d0038597421f367f8e3 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11add 'Save to PDF' link in sidebarRyota MIBU1-0/+19
Change-Id: Ia9ffd10aa73c9e39203f31a5a19329006b68a444 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-22improve configRyota MIBU1-40/+0
A developer was asked to copy all contents in the base config file in order to set all parameters properly, even if the change is partial. This patch improves this config by setting all default parameters based on users' custom config file, so that they can write parameters just which they want to change. Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-07migrate docs-build.sh from releng repoRyota MIBU3-0/+46
JIRA: DOCS-153 Change-Id: I568192dbb6653eb8fd8518abebf3558dc00dcee8 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>