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

automodapi overlapped text #93

Open
tcassanelli opened this issue Sep 22, 2019 · 6 comments
Open

automodapi overlapped text #93

tcassanelli opened this issue Sep 22, 2019 · 6 comments

Comments

@tcassanelli
Copy link

I'm using the current master branch of the astropy package template to build docs in my package pyoof. Everything works fine in the offline version, but when the online version builds there is text that overlaps in the API automodapi .

Offline
Screen Shot 2019-09-22 at 12 47 06 PM

Online
Screen Shot 2019-09-22 at 12 51 07 PM

I tried several options from the sphinx-automodapi , e.g.

.. automodapi:: pyoof
    :include-all-objects:

but again, it builds fine offline (python setup.py build_docs) but online it does not.
Perhaps it is something else that I need to fix this problem? maybe in conf.py file?
My package pyoof docs are here and the they are hosted in readthedocs.

@bsipocz
Copy link
Member

bsipocz commented Sep 23, 2019

I think it's likely to be a browser issue, I don't see this in your online docs (looking at it from firefox):
Screen Shot 2019-09-22 at 17 46 29

Totally separately run into a similar issue where an rst formatting was totally off for certain Safari versions (in a bulleted list the text were similarly overlapping with their bullets). I don't have a solution for that either as couldn't reproduce it in any of my browsers.

(Second guess would be some version mismatch between your local and RTD.)

@tcassanelli
Copy link
Author

@bsipocz thank you for your reply. My bad that I didn't check with other browsers. I was just curious because in an older version of my docs this didn't happen.

This seemed to have happened once I updated astropy_helpers to a newer version.

What do you mean with

(Second guess would be some version mismatch between your local and RTD.)

@astrofrog
Copy link
Member

Just for the record, I'm moving this issue to sphinx-automodapi since we should discuss it there.

@astrofrog astrofrog transferred this issue from astropy/package-template Jan 31, 2020
@bsipocz
Copy link
Member

bsipocz commented Apr 22, 2024

aren't the overlapping issues resolved by switching to the pydata-sphinx-theme?

@pllim
Copy link
Member

pllim commented Apr 22, 2024

I don't remember any mention of overlapping issue when we did pydata-sphinx-theme transition in astropy. Even if we did, probably won't fix pyoof?

@bsipocz
Copy link
Member

bsipocz commented Apr 22, 2024

I see overlapping menus in astroquery (that should have been an issue for astropy, too), but I'm certain that switching the theme will solve it. But I haven't seen this overlapping descriptions anywhere.

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

No branches or pull requests

4 participants