executablebooks / sphinx-comments

hypothes.is interaction layer with Sphinx
https://sphinx-comments.readthedocs.io
MIT License
21 stars 8 forks source link

Basic instructions do not work #19

Open kiteloopdesign opened 1 year ago

kiteloopdesign commented 1 year ago

Describe the bug

context Apologies if I am missing something gross but I do not see how at the moment, as the issue is pretty straight forward. I am doing the following to install sphinx-comments for development

git clone https://github.com/executablebooks/sphinx-comments
cd sphinx-comments
pip install -e .[testing,sphinx]

expectation It installs the sphinx extension and dependencies

bug

I get this error:

pip install -e .[testing,sphinx]
Defaulting to user installation because normal site-packages is not writeable
Obtaining file:///home/USEREDITED/projects/sphinx/sphinx-comments/sphinx_comments
ERROR: file:///home/USEREDITED/projects/sphinx/sphinx-comments/sphinx_comments does not appear to be a Python project: neither 'setup.py' nor 'pyproject.toml' found.

problem

Obvious, nothing is installed. It look a bit weird to me that the only available file is a __init__.py and no requirements.txt ? is this expected?

Thanks

Reproduce the bug

git clone https://github.com/executablebooks/sphinx-comments cd sphinx-comments pip install -e .[testing,sphinx]

List your environment

No jupyter book installed Fedora 35 Python 3.10.8

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: