Fix: Rather skip .tox instead of _build twice

Else it fails in ONAP if the warnings are treated as errors.

Issue: RELENG-3968
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I21e46ebae31a436b90361ce7ca19772b2cc3aced

Fix: Split concrete and abstract dependencies

It adds 2 upper-constraints to pin all the dependencies.
It modifies a little bit the official upper-constraints.txt from
OpenStack due to Sphinx (4.2.0 as asked by lfdocs-conf vs 3.5.2) and
due to setuptools (58.1.0 as used in ONAP gates vs 54.1.1).

In a long run, upper-constraints.os.txt should be removed once LF/ONAP
is synced with OpenStack. For it's part, upper-constraints.lf.txt
should be centralized for all ONAP/LF projects and then removed from
this particular project.

It also adds test-requirements.txt to list all test requirements (see
tox.ini) and lists sphinx contrib modules in requirements.txt which are
selected by the default configs. Otherwise the project must falsy lists
them as deps to complete the missing lfdocs-conf requirements.

Issue: RELENG-3968

Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I38057cdd0f3553d64c8a682faf0d304b680fcb96

Chore: Update to use funcparserlib~=1.0.0a0

Update funcparserlib for better compatibility
with Sphinx version 4.2.0 updated in commit
1f098cb2137c2d7b6132d44d5ad89de60336802a

This is requested by ONAP in IT-22918

Signed-off-by: Bengt Thuree <bthuree@linuxfoundation.org>
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Issue: RELENG-3968
Change-Id: Id181ed2ab65c9c6d923b73fb8968ffd69fac8bc0

Chore: Update to use Sphinx 4.2.x

Signed-off-by: Bengt Thuree <bthuree@linuxfoundation.org>
Issue-ID: IT-22918
Change-Id: I96a57d11a59d0dca889bb955a5bfe6cde8ff9c94

Fix: required sphinx-bootstrap-theme version

lfdocs-conf requires sphinx-bootstrap-theme version around 0.7.1
sphinx-bootstrap-theme v0.7.1 still uses the setup command "use_2to3".
This is no more allowed with latest versions of setuptools

https://stackoverflow.com/questions/69100275/

This breaks ODL current gating.
https://jenkins.opendaylight.org/releng/job/docs-rtd-verify-phosphorus/131/
https://git.opendaylight.org/gerrit/c/docs/+/97543/1

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I24f0b47f2898e7a9e2887e783caf36de5d0049b4

Fix: Rm dup word from ONAP Copyright notice

Issue-ID: RELENG-3929
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Change-Id: I0ae87fdaa9db07aebe3d3d91441b054418a4cf55

Docs: Update ONAP Copyright notice

Ref:
https://wiki.onap.org/display/Meetings/TSC+2021-08-05

Issue-ID: RELENG-3840
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Change-Id: I48b6386515787f6bf9e8c2dc8439d1256385f27a

Docs: Change ONAP copyright notice

TSC Approval:
https://wiki.onap.org/display/Meetings/TSC+2021-08-05

Issue-ID: RELENG-3840
Change-Id: I9677ffa06e23c54cb102e976cb17543e60f026d4
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>

CI: Fix pre-commit tox

The gitlint check is not working properly in CI. This change to tox will
make it so that tox works correctly both locally as well as in CI for
running the gitlint check

Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Change-Id: Ib2bd5b3b0159a5aee27a157b7e16269474681cd8

CI: Configure gitlint for Conventional Commits

Turn on Conventional Commit message subject validation. This will affect
CI specifically, but developers can avoid having CI fail by assuring
that they have installed pre-commit and that they have also run

pre-commit install --hook-type commit-msg

The above is needed because pre-commit does not install commit-msg hooks
by default.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I670a5099d43683435112bd71670618f569e3843d

CI: Update pre-commit checks to latest versions

This updates the pre-commit checks to the latest versions of the checks
we're using and fixes a linting issue in our YAML config.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ib0741cb73f678597576c84c3a1064c88931599d4

Fix: local calls to pre-commit tox profile

When run locally, pre-commit tox profile resulted in the following
failure:
$ tox -e pre-commit
[..]
gitlint...........................................................Failed
- hook id: gitlint
- exit code: 254

An error occurred while executing \
'/usr/bin/git config --get user.name': b''

The reason behind is that tox virtualenv cannot directly access the
$HOME shell variable to retrieve the local git configuration unless
this variable is explicitly declared accessible via the passenv tox
parameter.
This is required by gitlint to retrieve the correct git configuration
parameters.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I99197f88cf4024a5922fe62ec07610921dcf515f

CI: kick git hook pre-commit install out from CI

pre-commit hook installation is not required to run pre-commit run jobs.
And thus it is not wishable in CI and morevover in a local context since
no uninstallation method is provided in tox.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Idd7f1757b9814edfdeeb4013d086c8c63a6d812d

Fix: black pre-commit mutable rev configuration

pre-commit black current configuration uses stable for rev, what creates
warnings at pre-commit runtime as discussed at the following URL
https://github.com/psf/black/issues/420

"pre-commit assumes that the value of rev is an immutable ref (such as a
tag or SHA) and will cache based on that. Using a branch name (or HEAD)
for the value of rev is not supported and will only represent the state
of that mutable ref at the time of hook installation (and will NOT
update automatically)" as stated in the official documentation at
https://pre-commit.com/#using-the-latest-version-for-a-repository

rev stable has been replaced here by 21.5b1 in the precommit yaml file
to fix the warning and ensure CI and local pre-commit coherency.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I577d22e56155212bbb708213efb8f09c0283dd64

Fix: bandit pre-commit hook exclude regex

The 'exclude' field in pre-commit hook is a regex, not a glob,
as it is advertised by pre-commit runtime warnings.
"tests/*" matches "tests", "tests/" or "tests//...///" but also any file
or folder, not necessarily at the root of the project, that contains
"tests" in its name.
The right regex to ignore the tests folder at project root is "^test/"

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I74e22bff98c78a7d0dbabac81fdda7b07ed50d4f

Fix: conf.py imp import deprecation warning

According to https://docs.python.org/3/library/imp.html imp is
deprecated in favor of importlib since python 3.4 and imp.find_module
must be replaced by importlib.util.find_spec()

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: If3acf1b9aac6092a7a982598453d586316276dff

CI: Decrease Sphinx tox profiles logs verbosity

Docs and docs-linkcheck tox profiles are using Sphinx that generates
very verbose logs by default.
Sphinx -q quiet option allows to display only errors and warnings.
Using this option will ease potential gate failures analysis.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I55c587f2e17625f71e13197ab6f46bf470478738

Chore: replace py27 tox profile by py3

py27 was the default generic profile for jobs written in python 2.7 that
is now obsolete.

When forcing basepython version to 3, Jenkins advertises the incoherency
with a warning.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I10adbc4c1ee7de333e3bdd9a0e79e418ae49d5d7

Fix: prettier pre-commit configuration

According to https://github.com/prettier/pre-commit the prettier repo to
use in the pre-commit configuration file shifted to the new URL
https://github.com/pre-commit/mirrors-prettier

Also running this hook locally outside of the tox profile resulted in the
following error:

$ git commit --amend
[..]

gitlint...........................................................Passed
prettier..........................................................Failed
- hook id: prettier
- exit code: 2

[error] No matching files. Patterns: .git/COMMIT_EDITMSG

According to https://github.com/pre-commit/mirrors-prettier/issues/5
the reason behind is that prettier can not perform at the [commit-msg]
stage and only at the [commit] stage.
Forcing the stage parameter to [commit] in the hook configuration
managed to fix the issue.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I1991d5dbab8c6d4ad83e3466fdd4a7bc3cfc865a

Refactor: templates to format copyright year

Up to now, the copyright year was hardcoded in every project template
and had to be updated regularly.
To avoid manual updates and new versions of lfdocs-conf in Pypi,
it is preferable to use python3 datetime import with the format method
to fill and update the year automatically.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I35a7551a80be470dff5b55e0cabb4944a9bab02c

Fix: ONAP year in defaults

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I09d6a3b29064b4c82acbe38af430e1d80cd67dac

Fix: OpenDaylight years in defaults

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I3c99d7f281b376be5ac94c7a0db55fff239779ed

Add EPL License Header file

This should help contributors have a clearer idea of the licensing of
the code without having to look at setup.cfg or individual file
headers.

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

Update pre-commit hooks with recent version

- Switch write-good to upstream hook. Upstream PR [1.] is merged
  fixes issues with the write-good npm dependencies.
  [1.] https://github.com/btford/write-good/pull/126
- Swith prettier to the recent version v2.1.2

Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Change-Id: I286776e837c5147a3fef9c98ce38b5750106a645

Update Sphinx to 3.2.x

Change-Id: I32184a95a7d1b70774e5705c27f1605ec12d26e2
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Pytest is only required for testing

The end user does not need pytest to be installed to use docs-conf so
remove it from requirements.txt and include it only in test
dependencies in tox.ini.

Change-Id: I02180ba0985e42c9f20ba58a4faf11763a426838
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Limit more-itertools only if pyver is <3.4

As the comment says newer versions of more-itertools requires
Python 3.4 or greater. So only pin the version if that's the case.

Change-Id: I52f0e9d24056321df853e2105e399989d6ae64d5
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Migrate write-good to pre-commit hook

This final patch removes our dependency on the Coala platform and
migrates the write-good linter over to a pre-commit hook. Also resolves
some write-good issues that were ignored on the Coala platform.

Issue: INFRA-2642
Change-Id: I805f840bd651e76f877a9caccf9c4b80561aa01b
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Migrate yamllint to pre-commit hook

We'd like to move off of Coala as it hasn't had a release in a very
long time. This patch sets up the pre-commit configuration for the
yamllint hook as well as "prettier" for automated file formatting.

This patch also sets YAML indents to 2 as it is the corrent dominant
indent size for the YAML files in this project.

Issue: RELENG-2642
Change-Id: I3827d922023ac18519d94c906b211274ff3e65d9
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Migrate all Python linters to pre-commit

Switch Python related Coala linters over to pre-commit hooks. We would
like to migrate off of the Coala platform as it has not had a release
in years.

Issue: RELENG-2642
Change-Id: Ic6f10682c2d982a7980f1abb58303c56a6086bc8
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Add black to pre-commit

* Requires Python 3.6 or newer
* Changes pep8 max line length to 88 to match black
* Add .editorconfig to match black config
* Update tox to 2.0 to match black recommended version

This patch uses "black" to automatically manage Python style
conventions so that we don't have to. It utilizes pre-commit
to automatically handle running black on commit so that a
contributor does not have to think about it.

This however means that there is a required install step to
initialize a new dev environment using one of 2 options below:

1) Install pre-commit via your pkg manager then run:

    pre-commit install

2) Use tox to install pre-commit:

    tox -e check-hooks

Change-Id: I527e58b763dc7b0fdfa60fa619c61d2c63356d47
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update formatting with black

This is an auto-generated patch. Do not update it manually, the
follow up patch contains configuration to utilize pre-commit to
automatically handle code style. This patch should be merged
along with the follow up patch to activate black.

Change-Id: I0267bf7127a320a02dc2dd3d6121d48be8eecbe2
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Add reference to the project reqs.txt from docs

The docs/requirements.txt also needs to reference the project's
requirements.txt because this is a meta-docs project.

Change-Id: Ica9466dcd0255f3a4da1ca0ec3de9071dcbb71ce
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Fix RTD build failure due to missing pbr

Add pbr to lfdocs-conf requirements as RTD builds are failing due to
this dependency not being available in RTD. This requirements.txt only
affects docs build and is not a user facing change.

Change-Id: I2565f4d31a05facf25bd6f62ef3fe302d7309ea9
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Merge "Add support for sphinx-tabs extension"

Switch oran docs to sphinx_rtd_theme

This will allow read the docs to insert
the version picker into the oran docs UI

Issue-Id: IT-19981
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: Ie3ba2e5bd4f67060caa0886e7f914c67a8a9b5dc

Add support for sphinx-tabs extension

This extension allows us to use code tabs in docs.

Change-Id: I5e57e5056d5b6abc05842aa37ad6b7fadfe94ca8
Ref: https://github.com/djungelorm/sphinx-tabs
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Merge "Update Sphinx to 3.0.4"

Merge "Update pre-commit hooks 2020-06"

Update Sphinx to 3.0.4

Update docs-conf to use the latest Sphinx 3.0.4.

Change-Id: Ic44e8d44a0c68f5f3727f3e1b3ee3368b45d6cd2
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Make GitLint actually run as part of pre-commit

The tox environment for pre-commit currently does not actually run
the gitlint hook.

Change-Id: Idbb1f8878dfbc387468dcf9dc874f21a25ffa856
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Print git-diff when pre-commit fails

When pre-commit fails and automatically fixes issues for us in Jenkins
we are not able to see what pre-commit automatically fixed. Adding
--show-diff-on-failure makes pre-commit perform a git-diff immediately
after failing to ensure more useful output is printed to inform the
contributor what changes are needed to pass the check.

Change-Id: I5553c09d6079a71d64eebf3058e0cdec5fdf6b4f
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update pre-commit hooks 2020-06

It's been awhile since we last updated these hooks so let's catch
up with the world.

Change-Id: Ic3fec646f659403b8893134b49320984d412639c
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Bump OPNFV Copyright to 2020

Update the OPNFV documentation copyright to 2020.

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

Update Sphinx and bootstrap theme versions

Change-Id: Id81f717315470f9d6dbda5c074c6a1c405c6eefe
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Upgrade sphinx version to 2.2.2

sphinx-build breaks with osx when using the -j flag
for parallel builds, but is handled in v2.2.2:

https://www.sphinx-doc.org/en/master/changes.html

Signed-off-by: Jamo Luhrsen <jluhrsen@gmail.com>
Change-Id: Iaf218a41d8d8ac7b9b014ead0c2c8e117fb83027

Add onap

Add section for onap
with onap specific configs
taken from
onap/doc/docs/conf.py

Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I0655f21db43a2111db0477f98c592de4d420f850

Add Oran

Oran documentation is WIP
I will need this released
before we can complete this task

Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I3db6fc6644bc9f1f39e8cc6a8918b876902bcefd

Configure basepython to python3

More and more libraries that we are pulling in require Python 3 so
to avoid having to play the pin dependencies whack-a-mole game let's
bump or base python where possible to python3.

Change-Id: Ib25f0290675d2855ed29905331eb76ecbe39fdbf
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Pin pygments to 2.3.x

Pygments released 2.4.0 which added a python requires that excludes all
versions of Python < 3.5. The LFCI's default Python 3 version is 3.4 so
causes build failure.

Change-Id: Iecf065ccbc9de7782b64955c1cd904dfb1c16b8a
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Replace coala commit-msg hook with pre-commit

Idea here is to replace the slow coala checker with the
much faster pre-commit hooks in the future as we replace
the different linters we're using via coala with pre-commit
versions.

Using this requires the developer to setup pre-commit on their
local dev environment to initialize this the first time the
contribute to this repo.

Install can be performed via one of the following methods:

1) Install pre-commit from your local package manager then run:

    pre-commit install --hook-type commit-msg

2) Run `tox -e check-hooks`

Change-Id: I5b5d3dcbd7d83e90322f63ba99fa1f76c88ee8ad
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Add docs-linkcheck to test links

Change-Id: I83e718791c22311be0d96dd9137308a79c9fd14a
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update Sphinx cfg to use modern features from 1.8

* Enable --keep-going mode to fail at end after all warnings printed
* Use parallel auto mode
* Remove unnecessary echo command

Change-Id: I391d5fcc6675d78b0880c01e711b6749cc8174ec
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update Sphinx to version ~1.8

Sphinx 1.8 introduces a `--keep-going` parameter which will be handy
for our docs project so that it prints out all docs failures before
failing the build. This allows CI resources to not be wasted by only
printing one failure at a time.

Change-Id: I62c77a94f735fddcb8939aa5dbeb84566ae75d86
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update Python link to save redirect

This resolves the message we keep seeing when building docs that says
"intersphinx inventory has moved:" for this link.

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

pin more-intertools

Version 6.0.0 is a Python 3-only release
https://github.com/erikrose/more-itertools/releases

error form docs build:
more-itertools requires Python '>=3.4' but the running Python is 2.7.5

Change-Id: I6fa0b0e2bf96bfd66a3980d319570325b51666b9
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>

Pull version strings from PBR

We've been using PBR for awhile but never updated the docs config to
get it's versioning info from it.

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

Use reno for release notes

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

Release lfdocs-conf v0.2.5

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

Move docs reqs back to reqs.txt

We actually depend on lfdocs-conf to ship Sphinx to downstream
consumers removing it from requirements.txt was a bad idea.

Move it back and use skip_install=True in coala to have it skip
installing requirements.txt in the coala testenv.

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

Release lfdocs-conf v0.2.4

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

Pin Sphinx to version <1.8.0

The new 1.8.0 release of Sphinx is breaking builds in our CI.

In order to get tox runs to pass, the requirement files need to be split
apart and Sphinx version explicitly set for coala. This is due to some
coala bear requiring a version of Sphinx <1.5, which appears to get
pulled in from the base requirements.txt file.

This patch also includes minor clean up of the tox.ini file and a
pyflake validation fix.

Change-Id: Iea9b870270d7a8954f611aaca451de653397397a
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

Merge "Setup universal wheel"

Add PBR files to .gitignore

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

Setup universal wheel

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

Setup PBR

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

Bump lfdocs-conf to 0.3.0-dev

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

Release lfdocs-conf v0.2.3

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

Merge "Add "skipsdist = true" to tox.ini"

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 "skipsdist = true" to tox.ini

Most of our projects using Sphinx are not Python projects so
building sdist does not make sense for them. Default docs to
skip it since folks working on Python projects are more likely
to know what this parameter means.

Change-Id: Ib38395954c2fba988480cd5774b0e7ac46499b91
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>