Theme bug in 2.8 documentation site. #57957

Closed
opened 2018-11-20 13:27:39 +01:00 by Jean Da Costa · 59 comments

I've got a link to the new 2.8 documentation, and I've seem a weird bug of missing text.
Seems like a theme problem.

https://docs.blender.org/api/blender2.8/

image.png

I've got a link to the new 2.8 documentation, and I've seem a weird bug of missing text. Seems like a theme problem. https://docs.blender.org/api/blender2.8/ ![image.png](https://archive.blender.org/developer/F5650924/image.png)
Author

Added subscriber: @jeacom

Added subscriber: @jeacom

blender/blender#58309 was marked as duplicate of this issue

blender/blender#58309 was marked as duplicate of this issue

#57978 was marked as duplicate of this issue

#57978 was marked as duplicate of this issue

Added subscriber: @LosBopfos

Added subscriber: @LosBopfos

Changed status from 'Open' to: 'Archived'

Changed status from 'Open' to: 'Archived'
Christian Lutz self-assigned this 2018-11-20 19:45:51 +01:00

Nothing wrong.
Could be closed I think.

2018-11-20 19_42_18-Blender - Microsoft Visual Studio.png

Nothing wrong. Could be closed I think. ![2018-11-20 19_42_18-Blender - Microsoft Visual Studio.png](https://archive.blender.org/developer/F5655202/2018-11-20_19_42_18-Blender_-_Microsoft_Visual_Studio.png)
Author

I still see the bug, either in chrome or firefox.
maybe because I am using windows 7.

I still see the bug, either in chrome or firefox. maybe because I am using windows 7.

Added subscriber: @brecht

Added subscriber: @brecht

Changed status from 'Archived' to: 'Open'

Changed status from 'Archived' to: 'Open'

@LosBopfos, please leave triaging reports like this to developers.

Does https://docs.blender.org/manual/en/latest/ have the same problem?

@LosBopfos, please leave triaging reports like this to developers. Does https://docs.blender.org/manual/en/latest/ have the same problem?
Author

@brecht No, this page is fine.

@brecht No, this page is fine.
Member

Added subscriber: @Blendify

Added subscriber: @Blendify
Member
- Please post any messages in the chrome web console https://developers.google.com/web/tools/chrome-devtools/console/get-started#page - Please run a network log from chrome and upload the har file https://support.zendesk.com/hc/en-us/articles/204410413-Generating-a-HAR-file-for-troubleshooting
Member

Also are you using any particular web protection software? VPN? Ect...

Also are you using any particular web protection software? VPN? Ect...
Author

@Blendify
No messages in console
image.png

here is the .har file:
docs.blender.org.har

and I am not using any vpn or network protection, no adblocker enabled also.

@Blendify No messages in console ![image.png](https://archive.blender.org/developer/F5682548/image.png) here is the .har file: [docs.blender.org.har](https://archive.blender.org/developer/F5682555/docs.blender.org.har) and I am not using any vpn or network protection, no adblocker enabled also.

Added subscriber: @rjg

Added subscriber: @rjg

The second GET-request to https://docs.blender.org/api/blender2.8/ in your .har-file returns all the data in the html. Perhaps this is a rendering bug in your browser?

The second GET-request to https://docs.blender.org/api/blender2.8/ in your .har-file returns all the data in the html. Perhaps this is a rendering bug in your browser?
Author

I tried with both Firefox and chrome, and the bug happens exactly the same, since I disabled hardware acceleration on chrome and it happens exactly like in Firefox which have acceleration enabled, I guess it's not a hardware specific problem neither software specific.

I tried with both Firefox and chrome, and the bug happens exactly the same, since I disabled hardware acceleration on chrome and it happens exactly like in Firefox which have acceleration enabled, I guess it's not a hardware specific problem neither software specific.
Author

Just installed Opera to test and the same bug happens:
image.png

Just installed Opera to test and the same bug happens: ![image.png](https://archive.blender.org/developer/F5683645/image.png)
Author

Oh, I guess I figured out.
It looks like a font rendering problem:

The source fonts Lato-Bold.wolf2 and Lato-Regular.wolf2 aren't rendering even in the preview from the browser
image.png
Roboslab and Fontawesome fonst are working fine.
image.png

Oh, I guess I figured out. It looks like a font rendering problem: The source fonts `Lato-Bold.wolf2` and `Lato-Regular.wolf2` aren't rendering even in the preview from the browser ![image.png](https://archive.blender.org/developer/F5683718/image.png) `Roboslab` and `Fontawesome` fonst are working fine. ![image.png](https://archive.blender.org/developer/F5683730/image.png)

That is a bit strange. If your browser wouldn't support, it should load the *.ttf as declared in the font-face definition.

That is a bit strange. If your browser wouldn't support, it should load the *.ttf as declared in the font-face definition.
Author

Its loading all *.wolf2 fonts but somehow its not rendering some of them

Its loading all *.wolf2 fonts but somehow its not rendering some of them

Could you try to load this page and see if it renders properly (and if it loads the .woff2 files or another format)?

It should look like this:screenshot_webfonts.jpg

Could you try to load [this page ](https://google-webfonts-helper.herokuapp.com/fonts/lato?subsets=latin) and see if it renders properly (and if it loads the .woff2 files or another format)? It should look like this:![screenshot_webfonts.jpg](https://archive.blender.org/developer/F5684163/screenshot_webfonts.jpg)
Author

Everything looks fine in this page:
image.png

Everything looks fine in this page: ![image.png](https://archive.blender.org/developer/F5684419/image.png)

The Blender manual and 2.8 API docs are not being built on the same machine, probably using a different sphinx version or font file version. Either Windows 7 (32bit?) or the font file has a bug.

I guess it could be worked around by using a different font.

The Blender manual and 2.8 API docs are not being built on the same machine, probably using a different sphinx version or font file version. Either Windows 7 (32bit?) or the font file has a bug. I guess it could be worked around by using a different font.

The sphinx build shouldn't be a problem, everything down to the font-face definition in the css is correct. I think it's either a weird bug on @jeacom's system or the font file has some obscure error. The easiest way is to replace the Lato .woff2 files with a current version. That definitively won't break anything and possible fixes the problem, since the current version of Lato seems to render just fine.

The sphinx build shouldn't be a problem, everything down to the font-face definition in the css is correct. I think it's either a weird bug on @jeacom's system or the font file has some obscure error. The easiest way is to replace the Lato .woff2 files with a current version. That definitively won't break anything and possible fixes the problem, since the current version of Lato seems to render just fine.

Apparently there was an error with the extended latin characters in the Lato font in case your sphinx_rtd_theme still uses the pre August 2014 version.

Apparently there was an [error](https://fonts.google.com/specimen/Lato) with the extended latin characters in the Lato font in case your sphinx_rtd_theme still uses the pre August 2014 version.
Author

I've just downloaded new font files and replaced on a downloaded copy of the manual and this seems to fix the problem.
Hope someone do the same the the official docs..

I've just downloaded new font files and replaced on a downloaded copy of the manual and this seems to fix the problem. Hope someone do the same the the official docs..
Member

The api docs are being compiled with a older version probably 0.3.x the official version that we have now is 0.4.x which included fixes to the font stack. Who ever is in charge of this build system needs to make sure that they use the versions that are defined in the requirements.txt file.

The api docs are being compiled with a older version probably 0.3.x the official version that we have now is 0.4.x which included fixes to the font stack. Who ever is in charge of this build system needs to make sure that they use the versions that are defined in the requirements.txt file.
Christian Lutz was unassigned by Brecht Van Lommel 2018-11-30 15:02:36 +01:00
Bastien Montagne was assigned by Brecht Van Lommel 2018-11-30 15:02:36 +01:00

Added subscriber: @mont29

Added subscriber: @mont29

@mont29, since you are uploading these, can you try to upgrade to the latest sphinx version that fixes this problem?

@mont29, since you are uploading these, can you try to upgrade to the latest sphinx version that fixes this problem?

Am using debian testing packages, which seems to be 0.4.2 for the shpinx-rtd-theme one.

I think issue is rather within the API doc directory itself, we store our 'own' theme there, think it's just a matter of updating font file there and rebuilding… will try quickly now, otherwise that will have to wait for Sunday.

Am using debian testing packages, which seems to be 0.4.2 for the shpinx-rtd-theme one. I think issue is rather within the API doc directory itself, we store our 'own' theme there, think it's just a matter of updating font file there and rebuilding… will try quickly now, otherwise that will have to wait for Sunday.

Hmrrpf no, looks like our theme dir is minimal and does not includes fonts and such… And can confirm that fonts on API doc server and those from my debian package are exactly the same… :|

Hmrrpf no, looks like our theme dir is minimal and does not includes fonts and such… And can confirm that fonts on API doc server and those from my debian package are exactly the same… :|

@mont29 replacing the fonts in .\site-packages\sphinx_rtd_theme\static\fonts would then be the easiest way. Sphinx only copies those files anyway, so as long as the replacement files have the same name everything will work just fine.

@mont29 replacing the fonts in .\site-packages\sphinx_rtd_theme\static\fonts would then be the easiest way. Sphinx only copies those files anyway, so as long as the replacement files have the same name everything will work just fine.

@rjg not sure about that, again current font files are recent ones (0.4.2 version, from this October or so)… So issue pointed out by @Blendify is not the one at play here I think.

@rjg not sure about that, again current font files are recent ones (0.4.2 version, from this October or so)… So issue pointed out by @Blendify is not the one at play here I think.

The .ttf files here seem to have an old date though:
https://docs.blender.org/api/blender2.8/_static/fonts/

The .ttf files here seem to have an old date though: https://docs.blender.org/api/blender2.8/_static/fonts/

Ah, so issue is with the ttf ones in the end? This report is really confusing :/

debian's fonts-lato is indeed from before 08/2014, they probably did not repackage since then, so I guess those could be faulty. Will overwrite my system's Lato fonts and regenerate the API doc then.

Ah, so issue is with the ttf ones in the end? This report is really confusing :/ debian's fonts-lato is indeed from before 08/2014, they probably did not repackage since then, so I guess those could be faulty. Will overwrite my system's Lato fonts and regenerate the API doc then.
Author

Based on filenames loaded from my browser, I could check which files arent working and which ones are:
image.png

Based on filenames loaded from my browser, I could check which files arent working and which ones are: ![image.png](https://archive.blender.org/developer/F5789714/image.png)

Done, please report if this fixes your issue.

Done, please report if this fixes your issue.

.woff2 files are latest ones. only .ttf ones were old.

.woff2 files are latest ones. only .ttf ones were old.
Author

Weird, it's still not working.

Weird, it's still not working.

I believe the .woff2 files are supposed to be generated from the .ttf files, so they should have a modified date that is the same or newer than the .ttf files.

I believe the .woff2 files are supposed to be generated from the .ttf files, so they should have a modified date that is the same or newer than the .ttf files.
Author

I wish I could start learning the api soon.
Can someone share a download link for the zipped docs so I can try to fix locally?

I wish I could start learning the api soon. Can someone share a download link for the zipped docs so I can try to fix locally?
https://docs.blender.org/api/blender2.8/blender_python_reference_2_80_35.zip
Member

@mont29 you must not have the latest version of sphinx_rtd_theme newer versions print the version number in the css and js files. (https:*docs.blender.org/api/blender2.8/_static/css/theme.css) compare this to the master version: https:*raw.githubusercontent.com/rtfd/sphinx_rtd_theme/master/sphinx_rtd_theme/static/css/theme.css

Try running: pip install sphinx_rtd_theme --upgrade

@mont29 you must not have the latest version of `sphinx_rtd_theme` newer versions print the version number in the css and js files. (https:*docs.blender.org/api/blender2.8/_static/css/theme.css) compare this to the master version: https:*raw.githubusercontent.com/rtfd/sphinx_rtd_theme/master/sphinx_rtd_theme/static/css/theme.css Try running: `pip install sphinx_rtd_theme --upgrade`

@Blendify I have Debian testing version, stamped 0.4.2, which should be more than recent enough! And the problem is not there anyway, am told it’s font issue, this is not controlled by that sphinx theme. And no, I don’t want to meddle with pip if I can avoid it, distro package manager shall be the only one needed here. Since when do we need bleeding edge tools to build the docs????

@Blendify I have Debian testing version, stamped 0.4.2, which should be more than recent enough! And the problem is not there anyway, am told it’s font issue, this is not controlled by that sphinx theme. And no, I don’t want to meddle with pip if I can avoid it, distro package manager shall be the only one needed here. Since when do we need bleeding edge tools to build the docs????

and since when does this only pops up for 2.8 API doc? I’ve been building those for years with exact same package and never got any report so far… weird…

and since when does this only pops up for 2.8 API doc? I’ve been building those for years with exact same package and never got any report so far… weird…

Btw, @jeacom updated again also replacing woff2 lato fonts, hope this time its OK…

Btw, @jeacom updated again also replacing woff2 lato fonts, hope this time its OK…

@mont29 thanks for taking care of this. I would suggest using a venv for building the docs though, that makes it far easier to have the same versions as the main docs and perform upgrades as needed. No bleeding edge is certainly not required, but system packages may not be equal to the ones in available as pip package.

@mont29 thanks for taking care of this. I would suggest using a venv for building the docs though, that makes it far easier to have the same versions as the main docs and perform upgrades as needed. No bleeding edge is certainly not required, but system packages may not be equal to the ones in available as pip package.
Member

@mont29 you obviously don't have 0.4.2 version of sphinx_rtd_theme the theme assets simply do not match 0.4.2. You can confirm by checking the output of pip freeze or this python script:

from sphinx_rtd_theme import __version__

print(__version__)

We don't need bleeding edge tools, however, in this case we (speaking with a Read the Docs contributor hat) recently updated the packaging of font assets and our font stack. So if we are having an issue with font rendering thats the first step to try to fix it, simply using the latest version.

@mont29 you obviously don't have 0.4.2 version of `sphinx_rtd_theme` the theme assets simply do not match 0.4.2. You can confirm by checking the output of `pip freeze` or this python script: ``` from sphinx_rtd_theme import __version__ print(__version__) ``` We don't need bleeding edge tools, however, in this case we (speaking with a Read the Docs contributor hat) recently updated the packaging of font assets and our font stack. So if we are having an issue with font rendering thats the first step to try to fix it, simply using the latest version.
Author

Now the manual is working to me now, thankyou guys!
image.png

Now the manual is working to me now, thankyou guys! ![image.png](https://archive.blender.org/developer/F5801508/image.png)

@Blendify I do…

>>> from sphinx_rtd_theme import __version__
>>> __version__

'0.4.2'
@Blendify I do… ``` >>> from sphinx_rtd_theme import __version__ >>> __version__ '0.4.2' ```

Changed status from 'Open' to: 'Resolved'

Changed status from 'Open' to: 'Resolved'

@jeacom Thanks, closing then, will report the issue to debian too…

@jeacom Thanks, closing then, will report the issue to debian too…

Followup, in case someone is interested ;)

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=915410

Followup, in case someone is interested ;) https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=915410
Author

Changed status from 'Resolved' to: 'Open'

Changed status from 'Resolved' to: 'Open'
Author

Its happening again.

Currently I have to download the docs and replace the font files locally in order to read it properly.
image.png

Its happening again. Currently I have to download the docs and replace the font files locally in order to read it properly. ![image.png](https://archive.blender.org/developer/F6899073/image.png)

Changed status from 'Open' to: 'Resolved'

Changed status from 'Open' to: 'Resolved'

looks like my local override of those bloody deb-package fonts was overridden by some package update… re-uploaded API docs now, should be working again.

looks like my local override of those bloody deb-package fonts was overridden by some package update… re-uploaded API docs now, should be working again.
Sign in to join this conversation.
No Milestone
No project
No Assignees
7 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#57957
No description provided.