Skip to content
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.

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

1.34.7: sphinx no longer is able to build man pages #8886

Closed
kloczek opened this issue Aug 28, 2024 · 5 comments
Closed

1.34.7: sphinx no longer is able to build man pages #8886

kloczek opened this issue Aug 28, 2024 · 5 comments
Labels
closing-soon This issue will automatically close in 4 days unless further comments are made. documentation This is a problem with documentation. p2 This is a standard priority issue response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.

Comments

@kloczek
Copy link

kloczek commented Aug 28, 2024

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 kloczek added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 28, 2024
@kloczek
Copy link
Author

kloczek commented Aug 28, 2024

Looks like issue started somewhere after 1.34.2.

@tim-finnigan
Copy link
Contributor

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.

@tim-finnigan tim-finnigan added response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Sep 3, 2024
Copy link

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.

@github-actions github-actions bot added the closing-soon This issue will automatically close in 4 days unless further comments are made. label Sep 13, 2024
@kloczek
Copy link
Author

kloczek commented Sep 17, 2024

Looks like 1.34.20 is OK now.

Thank you and closing.

@kloczek kloczek closed this as completed Sep 17, 2024
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closing-soon This issue will automatically close in 4 days unless further comments are made. documentation This is a problem with documentation. p2 This is a standard priority issue response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.
Projects
None yet
Development

No branches or pull requests

2 participants