summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-05-23Fix docs build errorsTrevor Bramwell4-3/+27
This fixes the two error types being output by a Sphinx docs build: - numbered - This is already included in the root toctree (docs/index.rst) and doesn't need to be repeated - List spacing - Only in infra/jenkins/connect-to-jenkins.rst, the enumerated list of steps was missing spaces after each item Change-Id: I55555821a35a3d248f3a347e8e4d9c851254cf08 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-04-20Enable Local Docs builds by using LF Docs ConfTrevor Bramwell3-0/+7
The docs-conf[1] project will allow releng to have local docs builds using the OPNFV theme while also not needing to duplicate the opnfvdocs conf.py file. [1] https://github.com/lfit/releng-docs-conf Change-Id: I255faf045eccb363993af9dfb81b487e538cbb41 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-04-05Update Tox JJB CommandTrevor Bramwell1-0/+6
This allows using the command to only test one project's changes. For example: tox -e jjb -- jjb/releng Will only test jobs under 'jjb/releng'. If jobs have dependencies, of multiple project jobs need to be tested, they can be included using the jjb ':' syntax, as anything after '--' is passed directly to jjb: tox -e jjb -- jjb/doctor:jjb/functest Change-Id: I4b71803a1d6ed4f62d50cdca87183a68b20fae5a Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-03-21Release AutomationTrevor Bramwell2-0/+164
Tracking releases through yaml file similar to the openstack/releases project. Includes a schema file to be for validation, jobs for creating gerrit branches and stable branch jobs, and documentation for projects on creating their releases. Change-Id: Id1876482723e01806c0a6932126dff5ea314eae5 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-11-03Updated Docs StructureTrevor Bramwell18-17/+517
Provides a new organizational structure for release engineering documentation: /ci | Job/Gate structures and CI requirements /infra | Software Infrastructure documentation /component | Documentation specific to a component (Gerrit, etc.) /release | Release documentation (ex. stable branch policy) Change-Id: I8d24435d4d2f5ab797ad90309ee2246fb9b74c8e Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-11-02Testing new docs verfiy jobagardner1-15/+3
These docs changes are also legit. Looks like the reverify trigger is not working as well Change-Id: I8d16abf3ce0fcae88aec4e8b81b24deb3a991b34 Signed-off-by: agardner <agardner@linuxfoundation.org>
2017-04-01Add tox supportJulien1-0/+8
be easier to test jjb locally before submit for review. add unitest in modules dir to tox(tox -emodules) Change-Id: Ief4f10debc567d1d3ba111685c86b812a2058697 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2017-03-24Testing Jenkins SubscriptionShubhamRathi1-3/+3
Change-Id: I7e9e4040cf4b711e44ee003bfd13675f556501fa Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-23Testing gerrit subscriptionShubhamRathi1-2/+2
Change-Id: I801dac705223852a28d7e694e01db73f2da9d571 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-02Add trevorAric Gardner1-1/+2
This is to test verify and merge for new rtd builds Change-Id: Iaaf0730766559e18689ad617892ab77072d26fd2 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2017-01-30Document experimental jobsYujun Zhang1-0/+15
Change-Id: Ib4b81d60bbe81dec252ffa5bb5f66b2f86fd8a86 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-07-07fixes for docs-build.sh migrationRyota MIBU3-46/+0
JIRA: RELENG-130 See also https://gerrit.opnfv.org/gerrit/16515 . Change-Id: I365ecc4efd6f361f76ec527b4b43fae643f8478b Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-06-14Add note that you can add reviewers by groupAric Gardner1-1/+3
Also Remove peter and add mei JIRA: RELENG-115 You have all been added as reviewers by this method. If you do not wish to be added in this way please let me know. Details in JIRA ticket Change-Id: I37bf40afd6e3f5107f25d4a0bb19818f352d634b Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2016-06-10We don't need the how to use docs, since we know how to use themAric Gardner2-258/+0
Change-Id: I909071632502c1b8d4727362ffa49550d2feb42f Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2016-03-16Merge "docs: use venv"Ryota MIBU1-0/+5
2016-02-29docs: add hints of longtable and figure placementRyota MIBU1-4/+33
Change-Id: I1db5c67477d97c79c5291a27ddcc69914c491fb0 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-20docs: add instruction of python package installationRyota MIBU1-10/+26
Change-Id: I5d9ac75abe849f4dd27aaed483a73bd65db880dc Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-03docs: use venvRyota MIBU1-0/+5
Change-Id: I4dc0a46fa6b0793e6a62ea7b78ae3c2afcb64e00 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-28Add license headerFatih Degirmenci1-0/+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-12Add sphinx extensionsAna C1-1/+4
This change adds following sphinx extensions: - sphinx.ext.autodoc - sphinx.ext.viewcode - sphinx.ext.napoleon JIRA: - Change-Id: I97d8ead38fd8e83b98f5083d0e24dd1a084014c9 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2016-01-07fix build directory for OPNFV docsRyota MIBU1-2/+2
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-14docs: fix doc8 violationRyota MIBU1-145/+34
Change-Id: I5750dcc00d7b816ff78d4097b767ec05bc0e9eb5 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-10docs: add procedure to enable jenkins jobsRyota MIBU1-4/+18
Change-Id: I12769854edec391bebc7537d0bb999d61a4d3086 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-10docs: add process to request new sphinx extension(s)Ryota MIBU3-3/+25
http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2015-December/006901.html Change-Id: I3a2691bd1d69b5c8c250aaec34e4b76e28e7df73 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> Co-Authored-By: Ildiko Vancsa <ildiko.vancsa@ericsson.com>
2015-12-04docs: add sphinx extension 'httpdomain' to defaultRyota MIBU1-0/+2
Change-Id: I07cbbec02bbd995e66d6fd5965aecff3bb2e1dee Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-03Revert the global documentation conf.pyFatih Degirmenci1-1/+0
Need to revert this change since we now have docs with different themes. Projects can have their own conf.py files as explained in the documentation. http://artifacts.opnfv.org/releng/docs/how-to-use-docs/documentation-example.html#configuration This reverts commit 7916c5a19e6a6c55c6836347445b36fe981d1887. Change-Id: I9c169917adb130b36fe5dd70ac8f53ef8d9e3d83
2015-12-03Restore readthedocs themeblsaws1-0/+1
Change-Id: I73abb087e1c47880c71812e366a8bfec5d1ec3b5 Signed-off-by: blsaws <blsaws@hotmail.com>
2015-11-30update builder script and how-to-use-docsRyota MIBU5-67/+153
Change-Id: Ia65ebe61c174dc4129d32148d71505c2a2caf480 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-26jjb: fix doc build to support multiple depth of dirsRyota MIBU1-3/+7
JIRA: RELENG-16 Change-Id: I86293f9b79c083f286f9036a3137465513e92d17 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-26docs: remove trailing spacesRyota MIBU2-21/+21
Change-Id: Ib20408f178a28fe34f5bb06cd4707f1211495ad5 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-26doc: fix rst and jjb to have consistent view in html and pdfRyota MIBU5-62/+25
JIRA: RELENG-16 Change-Id: I6e36f16be6e1c9160820d137a78ac1e7674153f0 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-20doc: fix logo setting for sphinx-buildRyota MIBU5-34/+4
Change-Id: I53be7e1ec8e8c3b9134de40e99084e5ea623430c Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-19Add PDF creation in docu-build-new.shRyota MIBU1-10/+3
This patch adds PDF creation into the default document build script (utils/docu-build-new.sh), and also fixes default config file to avoid numfig issue. JIRA: RELENG-16 Change-Id: I6326d444cdc88e0ca6a748d7e3a9779b4321e57c Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-09-09Add documetation example, to be pushed to new projectsAric Gardner5-2/+124
moved the logo so that we only need one per docs directory added pipes to seperate the logo from the first line on the documentation JIRA: RELENG-15 Change-Id: I865092b236fd9447774ccd19ae756fd704cd6767 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-09-01Add sha1 and date to index.rstAric Gardner1-0/+3
date and sha1 need a space between them Change-Id: I8a43934437c80a43dd5c29c5d19531851e889012 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-08-31Add OPNFV LogoAric Gardner3-4/+14
JIRA: RELENG-17 Add |date| Add OPNFV logo Remove gen index TODO Sha1 is not updated Change-Id: I0436a04474027a7655cdfe8d0cf1db3bb26ce627 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-08-26Remove blank line to test new docs scriptAric Gardner1-1/+0
Change-Id: If1c05cc402c23d98822fc58d3db15f4b50dc1941 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-08-26Update list of reviewersAric Gardner1-3/+10
Change-Id: I997d0845b27cea7a168959a16cba313c81468a90 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-08-26Update docs to test scriptAric Gardner1-117/+124
Change-Id: I57414ba475b57377d4ee17c0bb7f85ae8b96ed07 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-08-26Adding initial docs, script and logic for releng projectAric Gardner3-0/+228
Change-Id: Ie5bebf61b5f539d31c4c270b3f86b68b7a3ff2c9 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>