Age | Commit message (Collapse) | Author | Files | Lines |
|
Issue-ID: OOM-2526
Signed-off-by: Pawel <pawel.kasperkiewicz@nokia.com>
Change-Id: I9fefdbfcee36ac8763910833b80534880ad5d7b1
|
|
docs.onap.org/projects
old location was
onap-doc.readthedocs.io
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I29688c00482647debbdd05bdbcc439d108e5c45d
|
|
ribbon.css is the correct name of the css file.
Issue-ID: CIMAN-376
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Change-Id: I6f7346767ec656c12ceb7e8bcfa1763e64ee2791
|
|
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I455858f33fc843b20fd86a9092ae206dd446e4bb
|
|
each project now has its own read the docs page
example:
https://onap-oom-offline-installer.readthedocs.io/
this will redirect to the subproject location
in this case:
https://onap-doc.readthedocs.io/projects/onap-oom-offline-installer/
Added a new section on the main page:
active-projects
it shows linking in action.
you can click through to the subproject docs from there.
you will land on genindex.html
This is not ideal
To see why this is the case you can run
python -m sphinx.ext.intersphinx
'https://onap-doc.readthedocs.io/
projects/onap-oom-offline-installer/en/latest/objects.inv'
refer to https://gist.github.com/Aricg/27c739da7c35d201e9ca034df6e30ef6
we must link to one of the avaliable std:label
This means that each project should add a lable to its main
index page so that we can propery link it.
eg, in their index.rst add
.. _projectname-mainindex:
or something we can agree on.
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I0e1b506d113b9fbbcf2cb854482dfb557d8012b7
|
|
template added in the conf.py file that signifies the metadata allowed.
necessary for the vnfrqts project.
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I9c50dc18ac22ec7ca575186a4761e1a277387b50
|
|
Now that we have a good build
https://onap-doc.readthedocs.io/en/latest/
we can revert this change and start building out
individual onap project docs.
Issue-ID: CIMAN-33
This reverts commit d54f2498fdb85f9c298b29bdc51532bef7e594b4.
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I2c9ce3e8043eef14e9573060ed3fe1a0e1dddfb1
|
|
This change is needed for a single build
this build will create and populate the onap-doc
repository so that other rtdv3 projects can be
a subproject of this master doc.
the change will then be reverted, so that
the old method of building docs continues to work
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I22686e4ef3061b4b32dfb494f31e284f80699073
|
|
now uses lfdocs-conf pip package.
needed for future move to rtdv3 jobs.
Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: Ic08a81100d8a4c59c2d326161662f207cfd9e25e
|
|
Issue-ID: DOC-467
Signed-off-by: Rich Bennett <rb2745@att.com>
Change-Id: Ia8a2181cdd00e3a47ba93b00ccd5ac7997b3dd89
|
|
Back out collapse_navigation change, it increases build time 6x
Upgrade sphinx release 1.8.4
Change-Id: Ib2a4e85712416c96a8096753f0f119d73b7d6c90
Issue-ID: DOC-406
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Added the Architecture and the Setting up ONAP pages to the sidebar
Issue-ID: DOC-401
Change-Id: I90261a5abf2aebd603692c05d6a7a29ce1decddc
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
|
|
|
|
Modification of the configuration ina way
that the navigation menu is always visible.
Change-Id: Ie5dc8e5afed071f49ae575ceb4411fbc1ebc0f37
Issue-ID: DOC-404
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
|
|
The 0.4.3 version of sphinx_rtd_theme supports the possiblity to change
background of the search area. This change modifies the background to
white to make it inline with the ONAP logo.
Issue-ID: DOC-402
Change-Id: I5156cf0ed146e12d9dbd2b5685a7ff563a88f6a2
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
|
|
Issue-ID: DOC-397
Change-Id: Ia48250a35c3cd8e483d80b50d5539c6eac3a4c4f
Signed-off-by: Manish Kumar <manishjpiet@gmail.com>
|
|
Switch to sphinx_rtd_theme
Add report issue in Jira with current page/release context
Change-Id: Ie237ee4d084f2b8bd025acc7499d19563f6e3e68
Issue-ID: DOC-310
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Replicating changes made when finalizing Beijing branch
in the doc master branch.
Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c
Issue-ID: DOC-280
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Add configuration, pip requirements, and conventiions for use
Change-Id: Ia065b7f72fc5aa16b4010b0100dc70e2f0a42b8c
Issue-ID: DOC-285
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Add private address ranges and example URL names
Add references to added or changed ui, ccsdk, and modeling rst files
Change-Id: I913ac118ec4ea5e60522ac6ba29a8d7f9cff14c4
Issue-ID: DOC-268
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Add frequently used acronyms or words used in ONAP documentation
Add representative domain or IP addresses are not expected to pass a linkcheck
Add sphinx extension for drawing network diagrams
Change-Id: Iea76f4a279da755fdd5d87e3b723ef261b9d19cd
Issue-ID: DOC-262
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Migrate top level structure from wiki
Eliminate duplicated subsections
Move to current stable release of Sphinx (1.6.7)
Change-Id: I2999962c306d69756161cb90993694877265b476
Issue-ID: DOC-259
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Update sphinx conf.py to show master branch
Change-Id: Ib62ff4699b179c6acaf3fe2ffb11372d9b56bc85
Issue-ID: DOC-58
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Sphinx Release=Amsterdam Version=1.0.0
Git tags 1.0.0-Amsterdam v1.0.0
Issue-ID: DOC-98
Signed-off-by: Rich Bennett <rb2745@att.com>
Change-Id: Ic9237e175d1fbecbf2ecd2e1b350d530de9baf2a
|
|
Change-Id: I4cfb33c8b79c654e98d25fef51b86ee505948db1
Issue-ID: SO-319
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
OfferedAPIs has been modified, should not cause RTD build timeout
Change-Id: Ic9c573edbe8fccd372f6abaf323e4e0b4f1cfad1
Issue-ID: DOC-157
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Adjusted headings to fit index
Corrected references to images
Made architecture provided by projects a reference list
Added build time and dropped the sphinx version on footers
Change-Id: I411ff51c5de2ad65c3c276d363d2fd3ed1ba35a7
Issue-ID: DOC-148
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Only used as an example of API documentation
Remove to allowing parallel reads during verify and build
Change-Id: Ib0549d12d80f986dba41c70706478c1fddfd9ef3
Issue-ID: DOC-142
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Temporarily exclude offeredapis.rst causing RTD updates to timeout
until root cause of delay eliminated or RTD quota can be increased
Change-Id: I39e495f8e82bbaa451e6ae2c5ec92234ad330de3
Issue-ID: DOC-140
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Integrate templates into Architeture and Release Notes
Remove excluded path auth/aaf.git for master branch
Change-Id: I49b7ee43823e27b99a7b20dff7d955e16691d912
Issue-ID: DOC-110
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Add footer reference to CC4 and make Copyright 2017 ONAP
Modify how to create documentation guide to describe appending copyrights on update contributions.
Update Collections Titles
Exclude aaf until source rst files are corrected for the next release.
Change-Id: I3ed26910b2bbb7a15c7c2865e40ff1e5545a00ff
Issue-ID: DOC-102
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Sync logging-analytis submodule reference
Add Repo names of release notes list
Configuration changes to evaluate theme and footnote options
Change-Id: Ib65612908b1739d138f16387d866dbfcc583cdbb
Issue-ID: DOC-41
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Part 1 of moviing linkcheck from verify to a CSIT job
Added API examples and extensions used to document APIs
Change-Id: I5dd536c50930b09bb129e95a9767c97f09c0604b
Issue-ID: DOC-82
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Change-Id: I2048e723c052f8a468f75b0abc9661320cf76380
Issue-ID: DOC-34
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Remove Sphinx exclusion of VNFRQTS repositories that were causing all doc
verify jobs to fail. These have been updated, should now verify, and
be published when merged
Improvements in the setup / getting started instructions for other
project creating documentation
Issue-Id: DOC-11
Change-Id: Ieb932dcaa0b4c39073e1e20cbdbe05bf6977a006
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
vnfrqts/requirements master advanced beyond submodule reference in doc before verify job available
updated git reference to current level
Improvements in the how to guide describing submodule integration
Updated sphinx configuration to support sequence diagrams
Temporary exclusion filter reduced for seed documents with severe errors
Issue-Id: VNFRQTS-76
Change-Id: I3928a3d1e55a0731125e07186d8041b1614c3c8d
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Improve How to Use Documentation Guide including display
existing templates, consistency with the approved Jenkins
job templates, and other editorial improvements
Change-Id: I6a173a656acee2d675cb4af4c3070ab9ab9eb893
Issue-Id: DOC-59
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Change-Id: Ib70e11d11edf82a5d9ac1d7d8d34a7ee460684a2
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Change-Id: Ib810ef3354ff17da35c57f563ecd8e15e9250fa3
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Change-Id: I483f12449de27a00421289438c73baa38e0fa1af
Signed-off-by: Rich Bennett <rb2745@att.com>
|
|
Change-Id: I5a638eba279092ada8874d09130120e9ce085b06
Signed-off-by: Rich Bennett <rb2745@att.com>
|