Skip to content

#301: Update PTB and workflows and activate generation of GH pages #302

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

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

Conversation

tomuben
Copy link
Collaborator

@tomuben tomuben commented Jun 16, 2025

fixes #301

Migrates documentation from markdown to sphinx/rst.

@tomuben tomuben deployed to manual-approval June 16, 2025 08:18 — with GitHub Actions Active
- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Build Documentation
Copy link

@ArBridgeman ArBridgeman Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You did the needed actions in Settings?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I could have been more specific. For using this GitHub action & deploying the documentation, you'll need to follow these steps: https://github.com/exasol/python-toolbox/blob/main/doc/user_guide/getting_started.rst?plain=1#L182 . I was confirming if you had, as I don't have permissions to double-check it myself 😄


- name: Build Documentation
run: |
poetry run -- nox -s docs:multiversion

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Locally, this command fails for me poetry run -- nox -s docs:multiversion with ERROR ERROR:exasol.toolbox.sphinx.multiversion.main:No matching refs found!.
(but poetry run -- nox -s docs:build, which runs in the PR #checks.yml is ok). I haven't set up documentation for the PTB yet, but I think, as I didn't see the issue in the docs, that this is not an expected error.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I investigated the error. I think the error is caused by the fact that doc/conf.py is not yet part of any tag or the main branch.
tbx multiversion filters by this file here

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think you're right. 😅

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.

Update PTB and workflows and activate generation of GH pages
2 participants