Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs with missing elements and update to latest Sphinx/Read The Docs #1129

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

RogerSelwyn
Copy link
Contributor

Docs update requires an action (which is in this PR) to build the pages, then the standard GitHub pages deployment will deploy that.

Currently the action is created to run on every push to master.

The PR also includes missing key docs for components that have been added since the last publication of the docs. I noted the docs had a stub entry for Query utils, which needs rounding out. It was not in the previous usage ToC, but it creates a warning from Sphinx because the definition for it is there and the warning stated it wasn't in a ToC.

@RogerSelwyn
Copy link
Contributor Author

@alejcas Not sure if this was of value to you. If not I'll bin it. I have some time spare, so could potentially expand on some of the documentation, but I'll only do it if it is of use.

@alejcas
Copy link
Member

alejcas commented Mar 11, 2025

Hi @RogerSelwyn, I’m having a lot of work these days. Will check this asap

@RogerSelwyn
Copy link
Contributor Author

@alejcas I thought it might be that, but I wanted to check. I’m happy to try an add some more descriptive documentation (perhaps extracting some from the Read Me) where it is missing rather than just the content scraped from the code. I’ll see what I can do over the coming days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants