SSH module documentation not generated in ReadTheDocs

Bug #1860450 reported by Dan Watkins
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Fix Released
High
Dan Watkins

Bug Description

It should appear on https://cloudinit.readthedocs.io/en/latest/topics/modules.html but it doesn't.

If I run `tox -e doc` locally, it _is_ included, which suggests this is an issue with our ReadTheDocs generation specifically, not the docs in general.

Revision history for this message
Joshua Powers (powersj) wrote :

From the build logs it looks like there are some additional docs missing as well:

WARNING: autodoc: failed to import module 'cc_byobu' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_landscape' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_mcollective' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_runcmd' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_salt_minion' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_set_passwords' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_ssh' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_ssh_authkey_fingerprints' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_ssh_import_id' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'
WARNING: autodoc: failed to import module 'cc_users_groups' from module 'cloudinit.config'; the following exception was raised:
No module named 'configobj'

Revision history for this message
Joshua Powers (powersj) wrote :
Changed in cloud-init:
status: New → Confirmed
importance: Undecided → High
Dan Watkins (oddbloke)
Changed in cloud-init:
assignee: nobody → Dan Watkins (daniel-thewatkins)
Revision history for this message
Chad Smith (chad.smith) wrote :
Changed in cloud-init:
status: Confirmed → In Progress
status: In Progress → Fix Committed
Revision history for this message
Chad Smith (chad.smith) wrote :

Confirmed proper ssh module docs are now present and live
https://cloudinit.readthedocs.io/en/latest/topics/modules.html#ssh

Changed in cloud-init:
status: Fix Committed → Fix Released
Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.