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

pip-compile totaly ignore sphinx-notfound-page from conf.py #239

Open
Hierosme opened this issue Jun 24, 2024 · 0 comments · May be fixed by #247
Open

pip-compile totaly ignore sphinx-notfound-page from conf.py #239

Hierosme opened this issue Jun 24, 2024 · 0 comments · May be fixed by #247

Comments

@Hierosme
Copy link

Hierosme commented Jun 24, 2024

Best sphinx publication warning a lot about fixe version of package use for generate the documentation.
For that pip-compile is the way.

Unfortunatlly i have to add sphinx-notfound-page because the commande

pip-compile --extra=doc --output-file=docs/requirements.txt pyproject.toml

Do not add sphinx-notfound-page inside docs/requirements.txt .txt

Here my conf.py import;

extensions = [
    'sphinx.ext.autodoc',
    'autoapi.extension',
    'sphinx.ext.intersphinx',
    'sphinx.ext.coverage',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'notfound.extension',
    'sphinxemoji.sphinxemoji',
]

The workarround is to declare pyproject.toml

[project.optional-dependencies]
doc = [
    "sphinx-rtd-theme",
    "sphinxemoji",
    "sphinx-autoapi",
    "sphinx-notfound-page",
]

I dont know why sphinx do not detect sphinx-notfound-page from conf.py

I dont know if a issue should be open on sphinx project or if a file should be edit inside sphinx-notfound-page project.

Regards

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 a pull request may close this issue.

1 participant