search

astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

automodapi overlapped text #93

Open tcassanelli opened 5 years ago

tcassanelli commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

@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 commented 4 years ago

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

bsipocz commented 7 months ago

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

pllim commented 7 months ago

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 commented 7 months ago

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.