summary |
shortlog | log |
commit |
commitdiff |
review |
tree
first ⋅ prev ⋅ next
Thanh Ha [Fri, 26 Jan 2018 05:54:47 +0000 (00:54 -0500)]
Add favicon.ico
Change-Id: I10cb9c8dd48431ce8ce7b7cdf9dc1ffd6209844a
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 20:06:50 +0000 (15:06 -0500)]
Add Documentation linting
Change-Id: I6e1cfebca8289549222e0879ca30f67067561484
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 20:24:33 +0000 (15:24 -0500)]
Remove weasel word
Change-Id: I80e97aa6c7b5ad75dc899222eac2ce1335820016
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 20:19:30 +0000 (15:19 -0500)]
Enable YAMLLint
Change-Id: I42ee8edd5994126461636ea9d349ae912a9e6e13
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 20:19:51 +0000 (15:19 -0500)]
Fix YAMLLint issues
Change-Id: I3c450edada171a8e4e3c3da19cd46f1985c6ecf7
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Trevor Bramwell [Thu, 25 Jan 2018 17:54:38 +0000 (09:54 -0800)]
Fix precedent listing to include 'defaults' path
Change-Id: I6a77f5f5524b9fc98f17d72cd59cb5c72e34efcb
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Trevor Bramwell [Thu, 25 Jan 2018 17:51:45 +0000 (09:51 -0800)]
Add YAML Header to Docs conf.yaml
Change-Id: Ie9c959b551842c370cff83f361439c817f5146d3
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 02:15:35 +0000 (21:15 -0500)]
Update intersphinx mapping URLs
Change-Id: I6930999cb1e643407a49a9eff033bcb32ad1b874
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 02:08:49 +0000 (21:08 -0500)]
Set default logo location to _static/logo.png
Let's standardize to a simple location. Projects can override
this in their own paths.
Change-Id: I8992eb3629219a356631e211e954c080c5c52e83
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 02:07:41 +0000 (21:07 -0500)]
Default to Sphinx 1.6.5
Change-Id: Ib7f60954095b0569992a20b7833cc844e6d36f27
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 01:56:41 +0000 (20:56 -0500)]
Require sphinx 1.6.5
Read The Docs has sphinx 1.6.5 installed so lets require that
as minimum to avoid having to put in workarounds for that.
Change-Id: I33e11cd9f687e2bf93aaf38a02e2c11cc640ad64
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
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
Code Review / releng / docs-conf.git / log