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

Sortable Tables #1062

Open
GruenSein opened this issue Dec 2, 2024 · 3 comments
Open

Sortable Tables #1062

GruenSein opened this issue Dec 2, 2024 · 3 comments
Labels
question A generic inquiry

Comments

@GruenSein
Copy link

Hi there,
I've been using confluencebuilder lately and have come to appreciate it immensely as it is a lot more practical and reliable than the atlassion-python-api and working with a well-structured rst documentation simply feels superior to dealing with individual API calls that tend to time out regularly. It has become part of my projects pipeline generating dynamically generated documentation and I am very satisfied with it. However, I am wondering if there is a way to generate sortable tables. Confluence offers corresponding macros but the tables generated from rst-files seem to be static only. This would improve the usefulness immensely. Is there a way to achieve this?
Thanks for all the work on this amazing tool!

@jdknight
Copy link
Member

jdknight commented Dec 3, 2024

@GruenSein, by chance, are you running on Confluence Cloud? From what I can tell, Confluence Cloud's tables by default (maybe force?) support of sortable tables with their newer editor (v2; "fabric"). This extension by default publishes using the v1 "legacy" editor type, mainly due to more support for various Sphinx/RST-related capabilities. If you are using Confluence Cloud, you can try using the more modern editing by configuring confluence_editor = 'v2' inside your conf.py file.

If you are not using Confluence Cloud and you have an instance that supports sortable tables, please let me know and I can try to investigate if there is anything special missing.

@jdknight jdknight added the question A generic inquiry label Dec 3, 2024
@GruenSein
Copy link
Author

Hi @jdknight, thank you for your response. Your suggestion works (see below). The downside of this is that confluence pages with many elements using the "v2" interface are quite slow. This is probably related to confluence and not the builder, though.

Anyway, thanks again!

image

@jdknight
Copy link
Member

jdknight commented Dec 4, 2024

Sadly, yes -- I wish I could provide a better answer here. Indeed larger pages do render slower when using the newer editor.

The only other suggestion I can give is if the tables you wish to be sorted are on their own pages, you can configure the editor type per page. For example, leaving confluence_editor unset and adding the following at the top of a page (rst):

.. confluence_metadata::
    :editor: v2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A generic inquiry
Projects
None yet
Development

No branches or pull requests

2 participants