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.

Sign up for GitHub

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

Jump to bottom

no space between argument and type in API reference #849

Closed
gdementen opened this issue Mar 6, 2020 · 3 comments
Closed

no space between argument and type in API reference #849

gdementen opened this issue Mar 6, 2020 · 3 comments
Assignees
@gdementen
Labels
bug priority: high
Milestone
0.32.2

Comments

@gdementen
Copy link
Contributor

This seems to be an incompatibility between read the docs theme and sphinx 2+:

readthedocs/sphinx_rtd_theme#766
@gdementen gdementen added this to the 0.32.2 milestone Mar 6, 2020
@gdementen gdementen self-assigned this Mar 6, 2020
@gdementen
Copy link
Contributor Author

references:
numpy/numpydoc#215
https://github.com/geopandas/geopandas/pull/1299/files

gdementen added a commit that referenced this issue Mar 30, 2020
@gdementen
fix #849: workaround to fix the missing space between parameters name…
80c52d5 
… and type in API doc
gdementen added a commit that referenced this issue Mar 30, 2020
@gdementen
fix #849: workaround to fix the missing space between parameters name…
97a89f1 
… and type in API doc
gdementen added a commit to gdementen/larray that referenced this issue Mar 31, 2020
@gdementen
fix larray-project#849: workaround to fix the missing space between p…
b73246f 
…arameters name and type in API doc
@gdementen
Copy link
Contributor Author

oh, come on. Just when everything was built correctly, I notice readthedocs somehow fixed this issue, and my fix thus introduce a second : and space 😭 ...

@gdementen
Copy link
Contributor Author

After investigation, the problem wasn't fixed on RTD side, the "double fix" is a side-effect of using pip instead of conda to install packages on RTD. RTD installs sphinx <2. So when "forward porting" the fixes from the 0.32.x branch to master, I will simply exclude the commit with the "fix". We can reintroduce it later in the unlikely case RTD uses more recent packages without fixing the separator/style issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gdementen gdementen

Labels
bug priority: high
Projects
None yet
Milestone
0.32.2
Development

No branches or pull requests
1 participant
@gdementen