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

Force Breathe extension for Sphinx to use the pyansys classes #49

Open
RobPasMue opened this issue May 20, 2022 · 0 comments
Open

Force Breathe extension for Sphinx to use the pyansys classes #49

RobPasMue opened this issue May 20, 2022 · 0 comments
Labels
dependencies Related with project dependencies enhancement General improvements to existing features

Comments

@RobPasMue
Copy link
Member

RobPasMue commented May 20, 2022

Description of the feature

I am not sure if this is the place to post this issue or not. I'll be pinging @jorgepiloto @Revathyvenugopal162 @akaszynski for discussion.

If you go to the following repository which uses the pyansys-sphinx-theme (https://github.com/ansys/api-eigen-example) you will see that in its docs, whatever has been rendered with the breathe extension (i.e. C++ code documentation compiled with Doxygen and reinterpreted with breathe) has a different look&feel in comparison to the Python code docs.

A simple example may be seen by comparing these two sections:

The goal is to have breathe use the same predefined classes of the pyansys-sphinx-theme so that the output has a similar look. This must probably be done via configuration of the breathe extension. Please, find the docs to the extension in the following site: https://breathe.readthedocs.io/en/latest/

Steps for implementing the feature

Not known yet :) but it should be possible.

Useful links and references

No response

@RobPasMue RobPasMue added enhancement General improvements to existing features dependencies Related with project dependencies labels May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies enhancement General improvements to existing features
Projects
None yet
Development

No branches or pull requests

1 participant