spirit icon indicating copy to clipboard operation
spirit copied to clipboard

Exporting documentation

Open GPMueller opened this issue 2 years ago • 3 comments

Originally posted by Sid281216 February 8, 2022 in discussion #612 Hi,

Equations in the documentation does not appear : in .mk files after build on windows, and on the readthedocs website https://spirit-docs.readthedocs.io/en/latest/core/docs/Definitions.html . But it works from GitHub repo website, there is a way to download a pdf of the docs directly from GH and still have equations ?

GPMueller avatar Feb 09 '22 11:02 GPMueller

The svg document contains

  * {
    fill: black;
  }
  @media (prefers-color-scheme: dark) {
    * {
      fill: white;
    }
  }

You can check this for example by opening this equation and checking the contents in the browsers "inspect" feature.

So it seems to me that the prefers-color-scheme: dark has the unintended effect that if the browser is set to dark mode, the equations will be white and therefore vanish on the white background because RTD is not. I was able to verify the equations show up if I set my browser settings to "light theme".

GPMueller avatar Feb 09 '22 11:02 GPMueller

Yes the problem was comming from there thanks, so to be able to have equations in Readthedocs website I changed my Edge navigator settings to light theme. And to be able to have them in markdown files(opened with VSCode) after spirit build, I had to change to light theme all Windows (W11). If I download a pdf of the docs from readthedocs website, equation still not apppear..

Sid281216 avatar Feb 09 '22 11:02 Sid281216

I don't know about the generated pdf, sorry. But at some point I believe the docs-page should be replaced by a docusaurus-generated one, which has its own light-/dark-mode switch, so I think the equations should always show up there. But I cannot tell when I'll have time to do that.

GPMueller avatar Feb 10 '22 12:02 GPMueller