summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2019-05-14Set Version and Release to HunterTrevor Bramwell1-24/+23
Updates the 'branch' config which is used for intersphinx linking, and sets the version/release to Hunter. Switches projects not in this release to link against their latest docs as they don't have a 'stable-hunter' to reference. Includes an update to '.gitreview' to ensure `git-review` submits a patch against the correct branch. Change-Id: Id2f46b8fd7f71eb3e46b7698896ab1d4059345f7 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2019-03-01Updating date in licence headerSofia Wallin1-1/+1
Updating from 2017 to 2019 in the licence header pubslished at the bottom of docs.opnfv.org Change-Id: Ib787ea034a23cf37ed92b99391e8f7fafb3705c6 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2018-11-09Merge "Comment out broken intersphinx links"Aric Gardner1-5/+4
2018-11-09Merge "Fix minor Documentation Formatting Errors"Aric Gardner1-1/+1
2018-11-09Comment out broken intersphinx linksTrevor Bramwell1-5/+4
Also removes the duplicate of 'auto' project which somehow slipped in. Change-Id: I8bfaa00d3ceebb8ec68e0e034acd5a8446a3b4dc Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-07Sort the list of intersphinx linked projectsTrevor Bramwell1-31/+31
Puts the intersphinx link definition in alphabetical order so it is easier to tell which projects are missing or already in place. Change-Id: Ic449abec34435ec5a72485224d9655a8c91963c9 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-06Fix minor Documentation Formatting ErrorsTrevor Bramwell1-1/+1
These include wrongly indented bullet points, title underlines, and malfomed links. Templates which are used for project documentation are also excluded from builds as they are orphaned pages. Change-Id: Iaabfb5f2bbf0b9bdfabec622e0b75dd23ea9e472 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-06Removing remaining submodulesSofia Wallin1-0/+31
Change-Id: I492e8fa3336b1e267aaa22f3ebdca8f5de4d1362 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech> Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-11-01Merge "Update git submodules for Promise"Trevor Bramwell1-0/+1
2018-11-01Transition stor4nfv docs away from submodulesSofia Wallin1-0/+1
Uses intersphinx linking to reference stor4nfv documentation hosted on RTD. Change-Id: I0e2dcf599073c6e59645e064ddacb3ef6289d084 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
2018-10-29Update git submodules for PromiseBertrand Souville1-0/+1
Transition to local documentation build for Promise as defined at: https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Change-Id: Icd35cd7b1c56a9de8625a685a8495067cfe60431 Signed-off-by: Bertrand Souville <souville@docomolab-euro.com> Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-29Create 'branch' variable in conf.py for linkingTrevor Bramwell1-7/+12
This will be used for linking against the correct version of the documentation on other projects when this project branches. Change-Id: I86391eb8ad1428b70f537288048c2c1b4597e928 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-29Merge "Convert Unlinked Git Submodules to Intersphinx"Aric Gardner1-0/+3
2018-10-26Convert Unlinked Git Submodules to IntersphinxTrevor Bramwell1-0/+3
These projects don't have any docs linked in the current documentation, so there is little reason to include their submodules here. Converting the non-archived projects to intersphinx link should reduce the build time. Change-Id: Ifdb614d53ac5cbdfa4c94ac09d990f796004cf10 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-24Update git submodules for AutoMartin Klozik1-0/+1
Transition to local documentation build for Auto as defined at: https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html Standalone Auto documentation is available at: https://opnfv-auto.readthedocs.io/en/latest/ This patch adds intersphinx link to the opnfvdocs repo configuration and removes auto submodule from docs/submodules/ Change-Id: I2e8a57734cd8e5318bbdcffb75876e6890d2f3da Signed-off-by: Martin Klozik <martin.klozik@tieto.com>
2018-10-19Transition Fuel and Armband off of SubmodulesTrevor Bramwell1-0/+1
Updates references to link to the project docs and removes links to non-existant documents. Change-Id: I10fe2b64063072ffc0a0a9a5661e267eb270456f Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-10-15Removing Fuel from submodulesSofia Wallin1-0/+1
Adding intersphinx linking to publish fuel documentation on RTD Change-Id: Ie968f373ce4d436878ad0c0bde132233a03df475 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2018-10-03Transition OVN4NFV Docs away from submodulesTrevor Bramwell1-0/+1
Uses intersphinx linking to reference ovn4nfv documentation hosted on RTD. Change-Id: I31a35c8c7bd49ab7f2e64edfec28d346652b0afc Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-09-04Switch Releng from submodules to intersphinxTrevor Bramwell1-3/+4
Removes the releng submodule, adds the pre-installed intersphinx to the list of extentions, and updates the releng links to point to the RTD site. Change-Id: I334077920e7aebbecc7e91d586110617622bb609 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-09-29Fix the version/release for latest documents on masterFatih Degirmenci1-2/+2
Change-Id: I28e8b3899d92fd6bc3220271ac47d5e2155df33d Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-05-02Misc ChangesShubhamRathi1-3/+4
1. Add sidebar akin to ODL 2. Remove redundant 'OPNFV' from all composite document titles 3. Edit documentation-example for the updated toolchain. Renamed this file as 'addendum.rst'. Eliminated obsolete content. 4. Listed test projects in alphabetic order Change-Id: Ica1c4aa89e3c8f8bcb960fcd4574971960dc52dc Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-27Show master branch as 'Latest'ShubhamRathi1-2/+3
Documentation built on RTD shows the branch name of the latest (master) branch as Danube. This patch fixes the branch name to 'Latest' Change-Id: I3d52fda5992fbb3e5fb17c9784d7a98396c0ebdc Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-16CSS Changes to layoutShubhamRathi1-1/+1
1. Logo has been scaled up 2. Font has been defaulted to 'Arial' Change-Id: I7d729009649ba59394f5a78c6909b6af21bae0ab Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-13Add SidebarShubhamRathi1-0/+1
Change-Id: I1425eda919f49cbc82d1ab60ef91324d9afee041 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-27Misc changesShubhamRathi1-2/+2
1. Added onvo, snaps, barometer submodules 2. Renamed a few titles Change-Id: I8b47e68d64a9a16576abbc2891a39b6dacf164ca Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-30Changing Documentation ThemeShubhamRathi1-1/+1
Documentation theme changed from 'united' to 'journal' Change-Id: I89242a324ea3bd827f829b07f43098d91c225eb8 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-26Removing RTD HackShubhamRathi1-4/+0
Eliminated rm -rf * from conf.py file & time, date of generation from index. Change-Id: I1c2c3da15a11b59659b9fbb46982bf71d7ec2ba9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-20RTD Workaround to delete old filesShubhamRathi1-52/+57
Workaround to delete old files in RTD: We are callling a subprocess from conf.py file to rm -rf *.The builds on RTD are failing but documentation is being updated nonetheless, to check - we are seeing the build time and date in index. Change-Id: I278490e322e97e263d90f568fe4331bcc40ff4ad Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-12Add conf.py, static filesShubhamRathi1-0/+278
Adding new conf.py & static files that shall be used to render docs. As part of the move to read the docs, intent is to have a single static conf.py at the root which shall manage the themeing etc. Change-Id: I71aedd1268649889e7e8c1e357fd3860f08ae390 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>