Remove echo of docs path

Since Sphinx 1.7.x Sphinx actually prints the path itself now
so we no longer need this explicit statement.

Change-Id: If2947ac6921fdefb3e51f1910a8f6819ffcf0d52
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add pre-commit hook for trailing-whitespace

Install using tox:

    tox -e check-hooks

ref: https://pre-commit.com

Change-Id: I80ac7933ee3d350c3d3d860e190b8348efd701e1
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Update lfdocs links to https

Save us on redirects when fetching the links.

Change-Id: Ic0d5290159a4af5bea54444ba4f106cc28ce3480
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Release lfdocs-conf v0.2.2

Change-Id: Ie6d8b97d96050553daa6df0b05d3b9500d438216
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Merge "Add flag to fail with warnings in instructions"

Add common-packer intersphinx mapping

Mapping allows all projects that use lfdocs-conf to be able to
intersphinx with CP without needing to add it to their local
conf.py config.

Change-Id: Icd4e36cc1391c881e3cbb083afc611792a9a4595
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add flag to fail with warnings in instructions

This is good practice so let's make sure our instructions set this
by default with a note in case a project is not ready for such a
configuration.

Change-Id: Ia71ca45af4e219c3eb50667772addbf77a584a82
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Bump version to 0.3.0-dev

Change-Id: I6561658d5b2194f456865bd2cb729bada2e0e30a
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Fail Sphinx build even on warnings

Change-Id: I5a6d6827870ff680cfc54c7aea171f1ce544a753
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Release lfdocs-conf v0.2.1

Change-Id: Ia1e8293e7fccf4ed1d02342c15b1197797ab0c9c
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Set _static defaults for LF Projects

Commit: 255554fd868f98da0b8e3a7b9cec959cc7945b59 change the defaults for
'html_favicon', 'html_static_path', and 'html_logo', but did not push
them into LF projects that use them.

Change-Id: I46b5256485443905a520c959e217297901548039
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Release lfdocs-conf v0.2.0

Change-Id: I10a435c092a5a8db9fd046a7a0c1bc7336e3a7ed
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Merge "Default release to version if not in use"

Use Sphinx defaults when config values are missing

More of these should be verified and moved into defaults.yaml where it
makes sense. We should not change those that make sense such as
'source_suffix', and 'master_doc'.

Change-Id: Iced9fbe6ddd20145d8aa354fdef5edb0638dbbdb
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Fix capitalization for Sphinx requirement

Change-Id: I92b089c74f49bcc9d10ec31e2d6a9e500e0803d6
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Default release to version if not in use

Simplify things by setting release = version for projects who do
not have the clear distinction.

Change-Id: I746f599ffc10012003c4268b1b31094bcaee5a6f
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Update URL listed in setup.py

The current URL 404s while the new URL lists the project patchsets.

Change-Id: I0a9793db118fe60e56db18e624ff59f4336d7daf
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Merge "Add missing links to docs-conf and valid defaults"

Merge "Update OPNFV Defaults"

Merge "Conditionally import OPNFV Theme"

Add missing links to docs-conf and valid defaults

- Link to a list of valid projects
- Link to docs-conf project

Change-Id: I3c0fbd4065a0f3aaf13e15282a9d025f04de3498
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add details on what to include in tox.ini

Missing information on adding a tox.ini so that the docs can
be generated and tested via `tox -e docs` command.

Change-Id: I900137817032e77109d891c7a194d3f956b1b278
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add a step to test the docs generation

Includes details on how to test and review the docs locally.

Change-Id: I0eb3761d0738ee511439b42bb107737fbd517d1b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Conditionally import OPNFV Theme

When using the 'opnfv' theme, conf.py needs to run the Python code
'sphinx_opnfv_theme.get_html_theme_path()' in order
to determine the location of package data on the filesystem.

Instead of having every project that wants to use the OPNFV theme set
this explicitly in their conf.py, we conditionally import the theme and
execute the code.

Change-Id: Ic686483fd511bf5e321977c2802f4cfb8986c800
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Update OPNFV Defaults

Configures the theme and an extra theme option along with updating the
copyright year and holder to match the current documentation.

Change-Id: Ifff21bd9782112419b8c209fba8d27f1dd7b3a90
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Add opendaylight defaults

Change-Id: I8e3ebf8ad5917f5642519b2fea96f0db8861eecd
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add initial RST documentation

Push in some initial documentation to get us started.

Change-Id: I1044204ddaff54ffcd4b24393fd91038dd3e4e28
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add favicon.ico

Change-Id: I10cb9c8dd48431ce8ce7b7cdf9dc1ffd6209844a
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add Documentation linting

Change-Id: I6e1cfebca8289549222e0879ca30f67067561484
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Remove weasel word

Change-Id: I80e97aa6c7b5ad75dc899222eac2ce1335820016
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Enable YAMLLint

Change-Id: I42ee8edd5994126461636ea9d349ae912a9e6e13
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Fix YAMLLint issues

Change-Id: I3c450edada171a8e4e3c3da19cd46f1985c6ecf7
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Fix precedent listing to include 'defaults' path

Change-Id: I6a77f5f5524b9fc98f17d72cd59cb5c72e34efcb
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Add YAML Header to Docs conf.yaml

Change-Id: Ie9c959b551842c370cff83f361439c817f5146d3
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Update intersphinx mapping URLs

Change-Id: I6930999cb1e643407a49a9eff033bcb32ad1b874
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

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>

Default to Sphinx 1.6.5

Change-Id: Ib7f60954095b0569992a20b7833cc844e6d36f27
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

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>

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>

Add sys path for rtd

Change-Id: I820fc0e5d183088a1128ab84f2d11fd3b32a0268
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

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>

Initialize Sphinx documentation

Change-Id: I814be3e544a45b96e9a882fc52f248cdeccb146d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Add missing license headers

Change-Id: I0559ce5115d2bd3157b4d329455f434afd19f35e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

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>

Bootstrap docs-conf project

Change-Id: I7e23f8be866f79d4e410b6e8628d33c6377b8b33
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

Initial empty repository