Add documentation

[Daltz333]

No description provided.

[Daltz333]

Not sure why it's failing, it works locally. Any ideas @TheTripleV

[modelmat]

Not sure why it's failing, it works locally. Any ideas

You don't install the extension in the CI.

See
https://github.com/Daltz333/sphinxext-opengraph/blob/efda5e6776c106d81e54596a22facdcc856753a4/.github/workflows/workflow.yml#L43-L45 for when it's done for other tests.

It will work locally because you have the extension installed locally already.

[Daltz333]

It is installed, see https://github.com/Daltz333/sphinxext-opengraph/blob/efda5e6776c106d81e54596a22facdcc856753a4/.github/workflows/workflow.yml#L61

[modelmat]

Open graph is not in those requirements.txt files.

[Daltz333]

It is, it's ../

[ItayZiv]

You need to uncomment these lines in conf.py

# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

and change the last line to

sys.path.insert(0, os.path.abspath('../..'))

(This is because you are installing the package from a nonstandard directory, so you need to add that directory to the sys.path)

[TheTripleV]

Can you have the ci upload the built html as an artifact?