From ed48f72c176e633d0c55e5cc0eeb90ac3f573d94 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 13 Oct 2017 12:51:12 -0400 Subject: [PATCH] Docs layout to pull in guides and tools Setup initial layout and populate with todo comments. Change-Id: I18ac021bca467f5157004e6d25463225544c4ad6 Signed-off-by: Thanh Ha --- docs/conf.py | 6 +++++- docs/index.rst | 18 +++++++++++++++--- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 64adff2..afe73f6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -353,5 +353,9 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + 'global-jjb': ('http://global-jjb.releng.linuxfoundation.org/en/latest/', None), + 'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None), + 'python': ('https://docs.python.org/', None), +} diff --git a/docs/index.rst b/docs/index.rst index 17246dd..54ce86d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,4 @@ -.. Linux Foundation Release Engineering Tools documentation master file, created by - sphinx-quickstart on Sat Mar 4 12:20:05 2017. +.. _lfreleng-docs: Linux Foundation Releng Documentation ===================================== @@ -8,8 +7,21 @@ Linux Foundation Release Engineering Documentation. A collection of documentation for Linux Foundation Continuous Integration (LFCI). -Contents: +Guides: +- Best Practices + +.. TODO Gerrit (RELENG-509) +.. TODO Jenkins (RELENG-510) +.. TODO Bootstrap a ReadTheDocs / Sphinx project (RELENG-512) +.. TODO Release Workflow (RELENG-511) +.. TODO Packer (RELENG-513) +.. TODO Javadoc (RELENG-515) + +Tools: + +- :ref:`lftools` +- :ref:`global-jjb` Indices and tables ================== -- 2.16.6