astropy / astropy/sphinx-automodapi

automodapi overlapped text

Open
#93 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

I'm using the current `master` branch of the astropy package template to build docs in my package [`pyoof`](https://github.com/tcassanelli/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](https://user-images.githubusercontent.com/8934433/65391427-1cf0e580-dd37-11e9-9f4d-6cffcb324880.png)

**Online**
![Screen Shot 2019-09-22 at 12 51 07 PM](https://user-images.githubusercontent.com/8934433/65391483-a99ba380-dd37-11e9-97d0-8024d8a282a5.png)

I tried several options from the [`sphinx-automodapi`](https://sphinx-automodapi.readthedocs.io/en/latest/automodapi.html) , 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](https://github.com/tcassanelli/pyoof/tree/master/docs) and the they are hosted in [_readthedocs_](https://readthedocs.org/projects/pyoof/).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the pyoof docs linked in the issue, especially docs/conf.py and the .. automodapi:: pyoof directive. Reproduce both python setup.py build_docs and the ReadTheDocs build, then compare the rendered API page and the sphinx-automodapi configuration. Done means the automodapi text no longer overlaps in the online build while remaining correct offline.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.