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

doxygen content exceding theme width #731

Closed
SuryaGrandhi opened this issue Feb 27, 2019 · 6 comments
Closed

doxygen content exceding theme width #731

SuryaGrandhi opened this issue Feb 27, 2019 · 6 comments
Assignees
Labels
Bug A bug Needed: more information A reply from issue author is required

Comments

@SuryaGrandhi
Copy link

SuryaGrandhi commented Feb 27, 2019

Problem

I am using doxygen to get API content using rtd theme. What I actually need is:
Expected output

But the content is going out of the width and not able to view the content. Like in here:
Actual Output

Reproducible Project

The rst file is something like this.

Functions
=========

Level 1 BLAS
-------------

rocblas_<type>scal()
^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: rocblas_dscal

.. doxygenfunction:: rocblas_sscal
rocblas_<type>copy()
^^^^^^^^^^^^^^^^^^
.. doxygenfunction:: rocblas_dcopy

.. doxygenfunction:: rocblas_scopy

Procedures Followed

I have tried:
Giving custom css in the _static folder.
Adding css to the class of the doxygen content.
Tried adding 'body_max_width': '80%' to the html_theme_options in conf.py file.

But not able to get any result as expected.

Expected Results

So, we need the doxygen API content aligned to the width of the theme but not exceeding the width and overflowing.

Environment Info

  • Python Version: 2.7.6
  • Sphinx Version: 2.0.4
  • RTD Theme Version:
@SuryaGrandhi
Copy link
Author

@Blendify Can you help us out here.

@Blendify
Copy link
Member

Blendify commented Mar 1, 2019

Is this the website?: https://rocblas.readthedocs.io/en/latest/allapi.html

I don't see the issue here. Also the the expected and actual links in the description are the same.

@SuryaGrandhi
Copy link
Author

Is this the website?: https://rocblas.readthedocs.io/en/latest/allapi.html

I don't see the issue here. Also the the expected and actual links in the description are the same.

I have updated the expected output link. The content is going out of the theme width/it is displaying in a single line rather in multiple lines.

@Blendify
Copy link
Member

Blendify commented Mar 4, 2019

I can confirm the issue after some digging. This happens when the methods contain long singular "words" opening a PR that should fix this.

Blendify added a commit that referenced this issue Mar 4, 2019
@Blendify Blendify self-assigned this Mar 6, 2019
@Blendify Blendify added the Bug A bug label Mar 6, 2019
@agjohnson
Copy link
Collaborator

@SuryaGrandhi do you have an actual link to the docs you're having trouble with. I don't think we can troubleshoot much with just the linked images.

I see something similar happening here:
image

But your linked examples have spaces in the text that should break. It makes me think your viewport size is altered or is extended due to some long content -- these elements are just filling the extra width.

The PR attached I don't think addresses the issue of a long word, i get this applying the fix on the linked docs above:
image

But this is because the element is code that is set to nowrap.

@agjohnson agjohnson added the Needed: more information A reply from issue author is required label Jul 18, 2019
@stsewd
Copy link
Member

stsewd commented Oct 8, 2020

Closing this as duplicate of #321

@stsewd stsewd closed this as completed Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: more information A reply from issue author is required
Projects
None yet
Development

No branches or pull requests

4 participants