search

wpilibsuite / sphinxext-opengraph

Sphinx extension to generate unique OpenGraph metadata
https://sphinxext-opengraph.readthedocs.io
Other
74 stars 27 forks source link

Add documentation #31

Closed Daltz333 closed 3 years ago

Daltz333 commented 3 years ago

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

modelmat commented 3 years ago

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 commented 3 years ago

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

modelmat commented 3 years ago

Open graph is not in those requirements.txt files.

Daltz333 commented 3 years ago

It is, it's ../

ItayZiv commented 3 years ago

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 commented 3 years ago

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