DiamondLightSource / aioca

Asynchronous Channel Access client for asyncio and Python using libca via ctypes
Apache License 2.0
6 stars 3 forks source link

Hosted documentation doesn't indicate async functions #2

Closed willrogers closed 3 years ago

willrogers commented 3 years ago

e.g. https://aioca.readthedocs.io/en/latest/api.html#aioca.caput

And yet if I build it locally the HTML does indicate async functions. Is this a Sphinx version difference?

thomascobb commented 3 years ago

Yes, readthedocs is on an older version of sphinx. I plan to move to GitHub.io soon...

willrogers commented 3 years ago

There doesn't seem to be anything here: https://dls-controls.github.io/aioca

thomascobb commented 3 years ago

I forgot to flick the setting in https://github.com/dls-controls/aioca/settings/pages. Then I wasted 2 hours trying to get Github Actions to do this for me in the workflow so I can put it in the template module, only to be greeted by:

{
  "message": "Resource not accessible by integration",
  "documentation_url": "https://docs.github.com/rest/reference/repos#create-a-github-pages-site"
}

Thanks GitHub...

willrogers commented 3 years ago

OK, looks good now.

At least the error message was clear enough.