Initial Commit of Sphinx Config project 63/7463/7
authorTrevor Bramwell <tbramwell@linuxfoundation.org>
Thu, 9 Nov 2017 22:23:15 +0000 (14:23 -0800)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Wed, 17 Jan 2018 02:57:33 +0000 (21:57 -0500)
commit9a17b6cc6e3137a6dabfabe41d29eabd9b96b5ff
tree99950f7bd9cf2fb9a14c946d7b04844a71c31837
parent06a1f2a92a8c544a347a8e7e783799f6f862b96f
Initial Commit of Sphinx Config project

Creates a lfdocs-conf package that is pip installable.

The minimal conf.yaml consists of only a project_cfg configuration
with the name of the project eg opendaylight, opnfv, lfdocs:

   ---
   project_cfg: lfdocs

Limitations:

intersphinx_mapping is not currently mappable via yaml due to
it being a complex data set of a tuple + data type (None). Projects
can override this by setting it in their local conf.py or accept the
defaults provided by the lfdocs-conf project.

Change-Id: Ia695047dc92adc00e4e9ec1f6d3ed824d10c0959
Co-authored-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
.gitignore
README.rst [new file with mode: 0644]
docs_conf/__init__.py [new file with mode: 0644]
docs_conf/defaults/default.yaml [new file with mode: 0644]
docs_conf/defaults/lfdocs.yaml [new file with mode: 0644]
docs_conf/defaults/opnfv.yaml [new file with mode: 0644]
requirements.txt [new file with mode: 0644]
setup.py [new file with mode: 0644]
tests/test_simple.py [new file with mode: 0644]
tox.ini