Repository navigation
LaTeX code in documentation not rendered #244
Description
Activity
Fixed in PR #288 as checked locally.
Online documentation still not rendered properly
Reacted by Zoltan CsatiI rechecked the build locally, and the formulas are rendering correctly. However, the live website is not updating because the GitHub Action responsible for deployment is not running.
In my view, the reasons are as follows:
- Wrong Trigger (main reason): It currently only runs on tags (releases), so merges to master do not trigger a rebuild of the website.
- Deprecated Runner: It uses ubuntu-18.04, which GitHub has removed. This may cause the job to fail even if triggered.
- Old Environment (optional): It uses Python 3.7. Perhaps not affecting this particular task but it's better to update this inline with the recent updates in the package.
I will open a new Pull Request to modernize
sphinx-build.ymlto fix the aforesaid issues.Great!
Online documentation is now correctly rendered!
Thanks @kshitij-maths !Reacted by Kshitij Kumar Pandey@kshitij-maths The CAD section is however empty now.
@CsatiZoltan Yes, I see. We'll fix it.
@ndem0 Note that to see the changes on the website, we need to create a tag as the CD is configured to only run on tag pushes. Since I don't have permission for this, do the needful.
You should be able to push a new tag!
BTW, I did it right now, the online documentation is updated online, butCAD.FFDandCAD.CADDeformationare not shown at all.
So please do the needful! And please double check locally!Do you mean the following links?
CAD.FFD: https://mathlab.github.io/PyGeM/ffdcad.htmlCAD.CADDeformation: https://mathlab.github.io/PyGeM/cad_deformation.html
They were already available locally. Also I checked online they are live now. Please see the attached images and let me know if it is okay or I'm missing anything.
Yes, you're right, now I can see everything! I don't know why initially those empty were empty at all. My bad, sorry! I'll close the issue!
Formulae are not rendered on the .github.io page (e.g. on https://mathlab.github.io/PyGeM/ffdcad.html), neither in Firefox, nor in a Chrome-based browser. Strangely, when I cloned the repository and built the docs by myself with
make html, it was shown properly. What could be the reason?