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

0.4.2: setuptools<>sphinx integration does not work #21

Open
kloczek opened this issue Jan 14, 2022 · 1 comment
Open

0.4.2: setuptools<>sphinx integration does not work #21

kloczek opened this issue Jan 14, 2022 · 1 comment
Assignees
Labels
bug Something isn't working stale

Comments

@kloczek
Copy link

kloczek commented Jan 14, 2022

Looks like setuptools<>sphinx integration does not work.

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.3.2

Configuration error:
config directory doesn't contain a conf.py file (/home/tkloczko/rpmbuild/BUILD/pyproject-parser-0.4.2)

All because docuemntation source is stored in doc-source/ when setuptools<>sphinx integration by default is looking for docs/conf.py.
Thre are two possible solutions:

  • rename doc-source/ to docs/
  • apply below patch
--- a/setup.cfg~        2021-08-11 12:25:07.000000000 +0100
+++ b/setup.cfg 2022-01-14 09:51:52.648856535 +0000
@@ -55,3 +55,6 @@
     pyproject-parser=pyproject_parser.__main__:main
     check-pyproject=pyproject_parser.__main__:main
     pyproject-fmt=pyproject_parser.__main__:main
+
+[build_sphinx]
+source-dir = doc-source

https://www.sphinx-doc.org/en/master/usage/advanced/setuptools.html

@kloczek kloczek added the bug Something isn't working label Jan 14, 2022
@stale stale bot added the stale label Jul 13, 2022
@pradyunsg
Copy link

sphinx-doc/sphinx#9595 deprecates and removes this command, in a future Sphinx release.

@stale stale bot removed the stale label Sep 1, 2022
@stale stale bot added the stale label Mar 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working stale
Projects
None yet
Development

No branches or pull requests

3 participants