Some examples use `nox -s` and others use `nox -e`. `-e` and `-s` are
aliases, but we should stick to one for consistency.
(cherry picked from commit 57764782a1)
* nox pip-compile: allow passing --no-upgrade flag
This allows running `nox -e pip-compile -- --no-upgrade` to make sure
that the requirements.txt files are in sync with the .in files but not
updating any other transitive dependency.
* README: make "## Updating dependencies" more concise
Co-authored-by: Don Naro <dnaro@redhat.com>
---------
(cherry picked from commit e952dd4365)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>
This PR adds a `make` session to the noxfile to automate running the
docs build Makefile and revamps the README to document the process. It
also updates the documentation_contributions docs to advise setting up a
venv in the same way that `nox` does.
(cherry picked from commit f1fe1d4c6d)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>
noxfile install(): log PIP_CONSTRAINT value
---------------------------------------------------------------
When pinned dependencies are enabled (the default), this will log the
value of the PIP_CONSTRAINT env var.
README: document Dependency files and PINNED envvar
------------------------------------------------------------------------------------
This documents the way dependency files are organized and handled by
nox.
---
(cherry picked from commit b274c97ec0)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Don Naro <dnaro@redhat.com>
Suggested-by: Don Naro <dnaro@redhat.com>
Ref: https://github.com/ansible/ansible-documentation/pull/668/files#r1371558583
**This is a backport of PR #668 as merged into devel
(8d8470468b).**
## Run docs checkers in the noxfile
This adds a checkers session to the noxfile to run docs checkers in
tests/checkers.py.
`nox -e checkers` runs all the docs checkers.
`nox -e 'checkers(rstcheck)'` and `nox -e 'checkers(docs-build)'` can
also be used to call individual checkers.
Simply executing `nox` will clone ansible-core, run the Python linters,
and the docs checkers (docs build test, rstcheck).
This makes it a lot easier for contributors,
as they can just run one command to make sure there changes will pass CI
before submitting a PR
and don't need to muck around with virtual environments and
dependencies.
## Use nox checkers session in CI
Now that the docs checkers are integrated into the noxfile, we can use
the nox session in CI instead of having to maintain separate CI
configurations for these jobs.
This change will cause branch protection to fail, as we no longer have
the docs-build and rstcheck CI jobs. I'll fix that when we're ready to
merge this.
Co-authored-by: Don Naro <dnaro@redhat.com>
* Document how to bump dependencies.
* Drop `-i`, keep `-t`.
* Expand option names.
* Place command in code block.
* Adjust command.
Co-authored-by: Maxwell G <maxwell@gtmx.me>
---------
(cherry picked from commit b9323fbe54)
Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Felix Fontein <felix@fontein.de>
* Convert README from Markdown to ReStructured Text and use as longdesc
Discussion in #13758 led to deciding to switch README to rst and having
setup.py consume it as the long_description.
* Fix long string in setup.py for pep8 compliance
* Open README.rst as read-only
* Update usages of root README.md to README.rst
Unsure about the file ./packaging/debian/docs as it (only) contains the
text README.md. I believe it's referencing ./packaging/debian/README.md
but maybe someone who knows debian packaging could review it?
* Pick up fixes that had been merged into README.md after the initial conversion to rst
* Fix the installation instructions link in the README
The original linked page (Getting started) assumed the user already had an installed system, which clearly was not the intention of the link.
So I replaced it with a link to the installation instructions, and removed the quick advice. The installation instructions are well structured and complete.
* Change to https
Links to ansible.com should end up over https
Seem to be missing the http -> https redirect from the docs site, I'll poke someone about that
Add tox integration to run unittests in supported python releases.
Travis-CI is used for test execution.
Additionally, the unittest TestQuotePgIdentifier was updated to support
using assert_raises_regexp on python-2.6.
Sample travis-ci output available at
https://travis-ci.org/ansible/ansible/builds/54189977
There should be a period after "Various release-X.Y branches exist for previous releases". It should read "Various release-X.Y branches exist for previous releases." This should keep the Branch Info listings consistent.
