Kolibri: Investigate: bulleted lists in dev docs are broken

[indirectlylit]

Acceptance Criteria

• [x] Determine the proper path forward for fixing it.
• [x] Either: Create a new issue to fix the problem once a likely solution is found OR fix it if it's a quick fix and submit a PR that closes this Issue.

Observed behavior

All bulleted lists in the dev docs are broken:

Expected behavior

Bulleted lists should be properly indented and annotated

User-facing consequences

Harder to read dev docs

Steps to reproduce

Navigate dev docs at https://kolibri-dev.readthedocs.io/

Context

This is definitely a regression, but after some initial investigation it seems to have existed for some time now – at least since 0.13

[radinamatic]

I'm not able to replicate this when I build the dev docs locally on current develop, bulleted lists display OK 🤔

I checked out the docs versions backward from develop to 0.12.x and was not able to replicate it anywhere. I'll investigate if it might be the RTD platform issue.

[chrislun16]

Is the issue that this isn't in a bulleted list (the section about a rule of thumb for inline bidirectional text)?

I built it locally and got the above screenshot. Looking at the i18n.html file, we are using * for a bulletpoint, so I'm not sure where the issue could be. Any suggestions?

[indirectlylit]

Looks like it's some kind of CSS problem because there are <ul> and <li> elements rendered in the DOM:

[nucleogenesis]

I get this issue too in Chrome. Another example: https://kolibri-dev.readthedocs.io/en/develop/getting_started.html#manual-testing

But the same on Github shows the bullets as expected.

The https://kolibri-dev.readthedocs.io/en/develop/_static/css/theme.css file declares:

ul, ol, dl {
    margin: 0;
    padding: 0;
    list-style: none;
    list-style-image: none;
}

Which strips the bullets. I don't know if we own that file - but if we do we should fix it there.

[jonboiser]

There's this file https://github.com/learningequality/kolibri/blob/7f76b3b2caa9b7866b318c7140d3a34704e3962d/docs/_build/_static/theme_overrides.css#L1

where I think you can add a new rule to override the list-style: none rule in the default styles.

[jonboiser]

@radinamatic I think by commenting out the list-style overrides in https://github.com/jonboiser/kolibri/pull/7, this fixes this issue.

I wouldn't have thought it since the rules in the override CSS are so specific 🤷

[radinamatic]

OK, I approved your PR @jonboiser, let's see if commenting out those rules will solve this! 🤞🏽

[jonboiser]

Nope, the latest build still has the missing bullet points. It seems that theme.css is different on https://kolibri-dev.readthedocs.io/ than when we're building locally, since the uls look fine locally.

[jonboiser]

The logs here might be useful for debugging why things are different online vs. running make docs

https://readthedocs.org/api/v2/build/13501819.txt

[radinamatic]

So annoying... 😒

We pin the sphinx-rtd-theme for dev docs to 0.4.3, which is 2 years old, I'll try updating that!

[jonboiser]

Fixed in #8002 🎉

[indirectlylit]

thanks!