Skip to content

rendering issue with activity_classification docs #8

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

Closed
siddacious opened this issue Nov 4, 2020 · 6 comments · Fixed by #23
Closed

rendering issue with activity_classification docs #8

siddacious opened this issue Nov 4, 2020 · 6 comments · Fixed by #23
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@siddacious
Copy link
Contributor

Note that the list of activities comes before the text that references it:

image

@siddacious siddacious added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 4, 2020
@evaherrada
Copy link
Collaborator

evaherrada commented Nov 25, 2020

I tried building the docs locally, and it built like it was supposed to. However, it seems it is not building like that here. I tried re-running actions after making a tiny change (it had been too long since the last actions run to just re-run it) but that didn't do anything. The same thing is happening with stability_classification, which would lead me to believe it has something to do with the bullet points for whatever reason.

Here's what it looks like locally:
Screenshot from 2020-11-25 10-10-02

One other thing I noticed is that locally, the light gray "property" thing appears before the name of the property, but is totally absent on the online docs.

@siddacious
Copy link
Contributor Author

@dherrada this seems like a difference in how Sphinx is being run locally and on readthedocs.org; Could be a Sphinx version difference, or a config file difference, however I believe RTD should be using our included config file.

@jposada202020
Copy link
Contributor

I build the documents in my readthedocs account and the documents are ok.
https://adafruit-circuitpython-bno08x-jdm.readthedocs.io/en/latest/api.html

We are having a similar issue here
adafruit/Adafruit_CircuitPython_DisplayIO_Layout#34 (comment)

@kmatch98 maybe this is related the way the CI and our local machines are building the documentation

@dhalbert
Copy link
Contributor

What versions have you installed? Let's see what pip3 list |egrep 'sphinx|recommonmark' says, and compare that to the CI settings.

@jposada202020
Copy link
Contributor

So System wise:

recommonmark                             0.7.1               
sphinx-autoapi                           1.7.0               
sphinx-rtd-theme                         0.5.1               
sphinxcontrib-applehelp                  1.0.2               
sphinxcontrib-devhelp                    1.0.2               
sphinxcontrib-htmlhelp                   1.0.3               
sphinxcontrib-jsmath                     1.0.1               
sphinxcontrib-qthelp                     1.0.3               
sphinxcontrib-serializinghtml            1.1.4               
sphinxcontrib-svg2pdfconverter           1.1.1   

However, the problem is not in my computer, I can build the documents fine.

For the displayIo library is contained in a ven, so doing the same command came empty. Just for information, I coudl build the documentation and create the html using sphinx-build -E -W -b html . _build/html without any problem inside.

@jepler
Copy link

jepler commented Apr 26, 2021

Keep in mind that what the github CI builds is not what RTD builds, that is a separate process.

@jposada202020 jposada202020 linked a pull request Apr 28, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants