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

plantuml images not published #1063

Open
nmosim opened this issue Dec 3, 2024 · 6 comments
Open

plantuml images not published #1063

nmosim opened this issue Dec 3, 2024 · 6 comments
Labels
investigation Developers are trying to look at this for more information or to reproduce third-party-extension Relates to a third-party Sphinx extension

Comments

@nmosim
Copy link

nmosim commented Dec 3, 2024

I am using this extension together with sphinxcontrib-plantuml. Unfortunately, plantuml images are not displayed on Confluence.

They are correctly generated in the build folder, but never published. This applies only for the "confluence" builder, the "singleconfluence" builder works as expected.

Versions:

  • sphinx: v8.0.0
  • sphinxcontrib-plantuml: v0.30
  • sphinxcontrib-confluencebuilder: v2.9.0

Did you ever observe such an issue?

@jdknight
Copy link
Member

jdknight commented Dec 3, 2024

There very well may be something broken in this extension, especially since you have indicated that it works with singleconfluence and not confluence. I can try to take some time later to investigate. Right now, the manual test for checking plantuml support is this sample project, which is limited. Last I recall that check works, but I'll re-run it again. But maybe there is a use case not being used here (plantuml in a nested folder/document)? If you are able to produce a sample project that shows the issue, it can help.

@jdknight jdknight added investigation Developers are trying to look at this for more information or to reproduce third-party-extension Relates to a third-party Sphinx extension labels Dec 3, 2024
@nmosim
Copy link
Author

nmosim commented Dec 3, 2024

There very well may be something broken in this extension, especially since you have indicated that it works with singleconfluence and not confluence. I can try to take some time later to investigate. Right now, the manual test for checking plantuml support is this sample project, which is limited. Last I recall that check works, but I'll re-run it again. But maybe there is a use case not being used here (plantuml in a nested folder/document)? If you are able to produce a sample project that shows the issue, it can help.

It is really strange. I am trying to reproduce it and somewhat failed. The first time I tried to publish a page, everything worked. Then, I tried something different and suddenly, all plantuml images are not published anymore. This is independent of the location of the page in the document tree.

Could it be related to intersphinx (I am not using it)?

@nmosim
Copy link
Author

nmosim commented Dec 3, 2024

I could now reproduce the issue: Whenever I delete the page (manually, through the browser) and republish it through the extension, the plantuml images are gone.

@jdknight
Copy link
Member

jdknight commented Dec 4, 2024

Could it be related to intersphinx?

Intersphinx should not be an issue for this case.

I could now reproduce the issue: Whenever I delete the page (manually, through the browser) and republish it through the extension, the plantuml images are gone.

Out of curiosity, are you deleting the page itself or did you delete the page's contents?

I tried to replicate the same steps and did not have luck when deleting the page. When I deleted the contents of an active page, I did notice that the page would not be updated. This is somewhat expected since this extension does not republish page updates it thinks that there have been no changes. Utilizing confluence_publish_force = True prevents issues in cases like this.

Are you using Confluence Cloud or Data Center by chance? Generating a report can help me ensure I can setup the exact version of Confluence to ensure there is no Confluence-specific issue.

@nmosim
Copy link
Author

nmosim commented Dec 4, 2024

I had yet another look at it. The issue disappears when I disable parallel builds (e.g. not passing -j auto to sphinx-build).

Adding various printouts for debugging revealed that the asset size is reset to 0 somewhere between the call to write_doc in ConfluenceBuilder and finish()

The issue also disappears if I simply set 'parallel_write_safe': False in the return value of the setup function.

@jdknight
Copy link
Member

jdknight commented Dec 5, 2024

Appreciated the additional testing. Unfortunately, I still haven't been able to reproduce (tested with auto and 18 job configurations, with 20+ plantuml documents). I'll keep tweaking the documentation/configuration to see if I can repeat the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
investigation Developers are trying to look at this for more information or to reproduce third-party-extension Relates to a third-party Sphinx extension
Projects
None yet
Development

No branches or pull requests

2 participants