confluencebuilder icon indicating copy to clipboard operation
confluencebuilder copied to clipboard

Workaround for unsupported extensions

Open egemenkarabyk opened this issue 3 years ago • 1 comments

As it can be seen from https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/features/, some of the very useful extensions we have in html builder are not supported by confluence builder. Is there any workaround to set specific themes for the page as we have in html_theme? Or is there any quick way to create links from documentation to source code as it is in sphinx.ext.viewcode extension(which is not also supported in confluence builder)?

egemenkarabyk avatar Apr 01 '22 10:04 egemenkarabyk

Is there any workaround to set specific themes for the page as we have in html_theme?

This extension does not have full control over the look-and-feel of the content being rendered on a Confluence instance. Confluence provides an API which can enable users to provide document data, and structure hints for said data, to be rendered for a given page. Theming for a Confluence space/instance is managed through site administration of a Confluence instance. If you are looking to apply a custom theme to a site/instance, you can try investigating Atlassian's documentation on Writing a Confluence theme.

[Is] there any quick way to create links from documentation to source code as it is in sphinx.ext.viewcode extension(which is not also supported in confluence builder)?

As you have already mentioned, yes, there is no support provided by this extension to generating links between documentation to source code (for code examples). While it would be nice to take advantage of capabilities provided by the sphinx.ext.viewcode extension, the extension's implementation is limited to only a subset of builder types.

jdknight avatar Apr 02 '22 00:04 jdknight

As discussed in an above comment, theming is outside this extensions scope and there is not much we can do for interacting with extensions that do not provide a means to interface with them. Users who are interested in trying to get support internal Sphinx extensions that could work with this extension are encouraged to introducing pull requests for these extensions. For example, see the progression towards supporting sphinx.ext.linkcode extension. For other extensions, it is recommended to bring up a discussion on their mailing lists/issue systems if there is a limitation that Confluence cannot manage.

With the above in mind, will be marking this issue a closed.

jdknight avatar Aug 21 '22 19:08 jdknight