sphinx-notes / sphinx-notes/pages

Issue Using Poetry in Non-package mode

Open
#39 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Shell
Stars
100
Forks
34
PR merge metrics
No merged PRs in 30d

Description

I have been trying to use this to deploy sphinx pages automatically. The issue seems to involve loading requirements from my pyproject.toml function, which was mostly generated using Poetry. For my use case I didn't want to run Poetry in package mode, as I didn't see the value in having the code available from Pypi. This, however, seems to make poetry fail to build the package (as it should, I just don't think this should be invoked), and I can't figure out why this issue is occurring or how to avoid it. I tried messing with some optional arguments, but they didn't seem to help.

I have included a link to my testing repo below.
https://github.com/rhit-mierowir/TestingGithub/blob/main/.github/workflows/sphinx-to-GHPages.yml

I think the error is happening here, and I am not sure what to do about it.
image

This is the error message I get:
image
...
image

Is there a way to compile sphinx in a non-package mode?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/sphinx-to-GHPages.yml in the linked testing repository and the pyproject.toml dependency-loading path mentioned in the report. Reproduce the failure from the workflow’s Sphinx and Poetry setup and determine whether non-package mode is supported. Done means the workflow builds and publishes the Sphinx pages without attempting an unwanted package build.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.