Skip to content

Run doc8 and reno lint in pep8 tox env #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2023
Merged

Run doc8 and reno lint in pep8 tox env #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/configuration/host-images.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The 3 partitions are:
* p0: EFI ESP bootloader
* p1: EFI BSP
* p2: LVM PV (``rootpv``)

The LVM Logical Volumes are:

============== ================== =========
Expand Down
2 changes: 1 addition & 1 deletion doc/source/configuration/monitoring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ need to be set, and the proxy URL sould be set or removed.
If you want to add an alerting rule, there are many good examples of alerts are
available `here <https://awesome-prometheus-alerts.grep.to/>`__. They simply
need to be added to one of the ``*.rules`` files in the prometheus configuration
directory.
directory.
8 changes: 4 additions & 4 deletions doc/source/configuration/release-train.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ see this message when you later try to run ``pulp-container-sync.yml``:
The issue is that pushing an image automatically creates a `container-push repository
<https://docs.pulpproject.org/pulp_container/restapi.html#tag/Repositories:-Container-Push>`__
which conflicts with the creation of a regular container repository of the same
name. You can resolve this conflict by deleting the distribution associated
name. You can resolve this conflict by deleting the distribution associated
with the push repository using the pulp CLI:

.. code-block:: console
Expand All @@ -241,17 +241,17 @@ with the push repository using the pulp CLI:
Started background task /pulp/api/v3/tasks/1f0a474a-b7c0-44b4-9ef4-ed633077f4d8/
.Done.

HTTP Error 404: Not Found
HTTP Error 404: Not Found
~~~~~~~~~~~~~~~~~~~~~~~~~

If your login credentials are incorrect, or lack the required permissions,
If your login credentials are incorrect, or lack the required permissions,
you will see a 404 error during ``pulp-repo-sync.yml``:

.. code-block:: console

TASK [stackhpc.pulp.pulp_repository : Sync RPM remotes into repositories] ****************************************************************************************************************************************
An exception occurred during task execution. To see the full traceback, use -vvv. The error was: Exception: Task failed to complete. (failed; 404, message='Not Found', url=URL('https://ark.stackhpc.com/pulp/content/centos/8-stream/BaseOS/x86_64/os/20211122T102435'))
failed: [localhost] (item=centos-stream-8-baseos-development) => changed=false
failed: [localhost] (item=centos-stream-8-baseos-development) => changed=false
ansible_loop_var: item
item:
name: centos-stream-8-baseos-development
Expand Down
2 changes: 1 addition & 1 deletion doc/source/configuration/walled-garden.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In some environments we have found that squid’s preference for IPv6 can
cause problems. It can be forced to prefer IPv4, by adding the following
in ``etc/kayobe/containers/squid_proxy/squid.conf``:

.. code:: none
.. code::

dns_v4_first on

Expand Down
8 changes: 4 additions & 4 deletions doc/source/contributor/environments/ci-multinode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==========================
Multinode Test Environment
Multinode Test Environment
==========================

Set up hosts
Expand All @@ -21,7 +21,7 @@ Basic Kayobe Setup
2. ``sudo dnf install -y python3-virtualenv``
3. ``mkdir src`` and ``cd src``
4. Clone https://github.com/stackhpc/stackhpc-kayobe-config.git, then checkout
commit f31df6256f1b1fea99c84547d44f06c4cb74b161
commit f31df6256f1b1fea99c84547d44f06c4cb74b161
5. ``cd ..`` and ``mkdir venvs``
6. ``virtualenv venvs/kayobe`` and source ``venvs/kayobe/bin/activate``
7. ``pip install -U pip``
Expand All @@ -39,8 +39,8 @@ Config changes
4. Also under vxlan_interfaces, check vxlan_dstport is not 4789 (this causes
conflicts, change to 4790)
5. In /etc/kayobe/environments/ci-multinode/tf-networks.yml, edit admin_ips so
that the compute and controller IPs line up with the
instances that were created earlier, remove the other IPs for seed and
that the compute and controller IPs line up with the
instances that were created earlier, remove the other IPs for seed and
cephOSD
6. In /etc/kayobe/environments/ci-multinode/network-allocation.yml, remove all
the entries and just assign ``aio_ips:`` an empty set ``[]``
Expand Down
2 changes: 2 additions & 0 deletions test-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
# process, which may cause wedges in the gate later.

yamllint # GPLv3
doc8 # Apache-2.0
reno>=3.4.0 # Apache-2.0
2 changes: 2 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ deps =
[testenv:pep8]
commands =
yamllint etc/kayobe
reno lint
doc8 README.rst doc/source --ignore D001

# StackHPC Kayobe configuration release notes:
[testenv:releasenotes]
Expand Down