summary |
shortlog | log |
commit |
commitdiff |
review |
tree
first ⋅ prev ⋅ next
Thanh Ha [Thu, 25 Jan 2018 01:41:17 +0000 (20:41 -0500)]
Move code out of __init__ and into conf.py module
This allows us to use __init__.py to store __version__ and other
metadata strings and be reused in local documentation and setup.py
to shore a single version file.
The problem with having code in __init__.py is that the code will
be executed even if all the documentation code wants to pull is the
metadata variable.
Change-Id: I7382c81508be42a41c99f392f8006cfdf9887258
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 01:13:36 +0000 (20:13 -0500)]
Add sys path for rtd
Change-Id: I820fc0e5d183088a1128ab84f2d11fd3b32a0268
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 00:25:30 +0000 (19:25 -0500)]
Update Python linter to lint all docs_conf code
Also resolve lint issues.
Change-Id: Ifab8d9c3c3cfffab8609cc0740862f2718986aa6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Wed, 24 Jan 2018 23:45:27 +0000 (18:45 -0500)]
Initialize Sphinx documentation
Change-Id: I814be3e544a45b96e9a882fc52f248cdeccb146d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 00:23:54 +0000 (19:23 -0500)]
Add missing license headers
Change-Id: I0559ce5115d2bd3157b4d329455f434afd19f35e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Trevor Bramwell [Thu, 9 Nov 2017 22:23:15 +0000 (14:23 -0800)]
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>
Thanh Ha [Wed, 8 Nov 2017 21:07:49 +0000 (16:07 -0500)]
Bootstrap docs-conf project
Change-Id: I7e23f8be866f79d4e410b6e8628d33c6377b8b33
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Andrew Grimberg [Wed, 8 Nov 2017 19:36:36 +0000 (19:36 +0000)]
Initial empty repository