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

documentation: line numbers in code-blocks don't match actual lines #1041

Closed
ltalirz opened this issue Jan 15, 2018 · 7 comments
Closed

documentation: line numbers in code-blocks don't match actual lines #1041

ltalirz opened this issue Jan 15, 2018 · 7 comments
Assignees

Comments

@ltalirz
Copy link
Member

ltalirz commented Jan 15, 2018

Example: Search for "Here is the code:" on http://aiida-core.readthedocs.io/en/latest/work/index.html

This is a known bug in sphinx_rtd_theme, which has been fixed in v0.2.5
readthedocs/sphinx_rtd_theme#415

To do: Update setup_requirements.py accordingly and check that the problem is gone.

@sphuber
Copy link
Contributor

sphuber commented Jan 15, 2018

Fixed in #1044

@sphuber sphuber closed this as completed Jan 15, 2018
@ltalirz
Copy link
Member Author

ltalirz commented Feb 15, 2018

Forgot to update requirements for RTD

@ltalirz ltalirz reopened this Feb 15, 2018
sphuber added a commit that referenced this issue Feb 15, 2018
@ltalirz
Copy link
Member Author

ltalirz commented Feb 16, 2018

For the moment, it isn't fixed yet...
http://aiida-core.readthedocs.io/en/latest/work/index.html

When are the builds triggered?

@ltalirz ltalirz reopened this Feb 16, 2018
@ltalirz
Copy link
Member Author

ltalirz commented Feb 19, 2018

There recently was a bug causing the builds on readthedocs to fail (#1143 ).
This is fixed now, and the docs build again, but the issue remains.
The reason is that, although we explicitly require sphinx-rtd-theme==0.2.5b2 (and the wheel is being downloaded!), for some reason rtd still ends up installing version 2.4:
https://readthedocs.org/projects/aiida-core/builds/6771473/

I'm ready to give up here... I guess we'll have to wait until rtd gets its act together, unless anyone else has a better idea @giovannipizzi @sphuber

@ltalirz
Copy link
Member Author

ltalirz commented Feb 21, 2018

@giovannipizzi
Copy link
Member

I tried some additional modifications with a local version of the theme, without success.. Probably at this point we just have to wait that RTD fixes the problem on their side... (I don't know if we want to merge the rtd_fix, as I put a local version of the theme, and this anyway does not work. We can either revert to your first commit and merge that, or just delete the branch).

@ltalirz
Copy link
Member Author

ltalirz commented Feb 22, 2018 via email

@sphuber sphuber closed this as completed in 5ce96d5 May 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants