1.34.7: sphinx no longer is able to build man pages

[kloczek]

Describe the issue

Looks like currently it is some issue with building documentation and html output is almost empty and man pages are are not generated however none of the warnings or errors are printed by sphinx.

+ /usr/bin/sphinx-build -n -T -b man doc/source build/sphinx/man
Running Sphinx v8.0.2
loading translations [en]... done
making output directory... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index

/home/tkloczko/rpmbuild/BUILD/aws-cli-1.34.8/doc/source/index.rst:8: WARNING: toctree contains reference to nonexisting document 'reference/index' [toc.not_readable]
/home/tkloczko/rpmbuild/BUILD/aws-cli-1.34.8/doc/source/index.rst:8: WARNING: toctree contains reference to nonexisting document 'topic/index' [toc.not_readable]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... WARNING: "man_pages" config value references unknown document reference/index
WARNING: "man_pages" config value references unknown document reference/autoscaling/index
WARNING: "man_pages" config value references unknown document reference/cloudformation/index
WARNING: "man_pages" config value references unknown document reference/cloudwatch/index
WARNING: "man_pages" config value references unknown document reference/datapipeline/index
WARNING: "man_pages" config value references unknown document reference/directconnect/index
WARNING: "man_pages" config value references unknown document reference/dynamodb/index
WARNING: "man_pages" config value references unknown document reference/ec2/index
WARNING: "man_pages" config value references unknown document reference/elasticache/index
WARNING: "man_pages" config value references unknown document reference/elasticbeanstalk/index
WARNING: "man_pages" config value references unknown document reference/elastictranscoder/index
WARNING: "man_pages" config value references unknown document reference/elb/index
WARNING: "man_pages" config value references unknown document reference/emr/index
WARNING: "man_pages" config value references unknown document reference/iam/index
WARNING: "man_pages" config value references unknown document reference/importexport/index
WARNING: "man_pages" config value references unknown document reference/opsworks/index
WARNING: "man_pages" config value references unknown document reference/rds/index
WARNING: "man_pages" config value references unknown document reference/redshift/index
WARNING: "man_pages" config value references unknown document reference/route53/index
WARNING: "man_pages" config value references unknown document reference/s3/index
WARNING: "man_pages" config value references unknown document reference/ses/index
WARNING: "man_pages" config value references unknown document reference/sns/index
WARNING: "man_pages" config value references unknown document reference/sqs/index
WARNING: "man_pages" config value references unknown document reference/storagegateway/index
WARNING: "man_pages" config value references unknown document reference/sts/index
WARNING: "man_pages" config value references unknown document reference/support/index
WARNING: "man_pages" config value references unknown document reference/swf/index
done
build succeeded, 29 warnings.

The manual pages are in build/sphinx/man.

Links

All documentation is affected.

[kloczek]

Looks like issue started somewhere after 1.34.2.

[tim-finnigan]

Thanks for reaching out. I tried to reproduce this issue on 1.34.10 — upon building the docs I get several warnings, I did not get the specific ones you referenced (WARNING: toctree contains reference to nonexisting document 'reference/index' [toc.not_readable]).

I think further investigation is required in order to try and reproduce this. Please us know if you have more info on your end, or if you can point out in the CHANGELOG which version/changes may be causing that.

[github-actions]

Greetings! It looks like this issue hasn’t been active in longer than five days. We encourage you to check if this is still an issue in the latest release. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or upvote with a reaction on the initial post to prevent automatic closure. If the issue is already closed, please feel free to open a new one.

[kloczek]

Looks like 1.34.20 is OK now.

Thank you and closing.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.