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

Update CONTRIBUTING.rst #214

Closed
neuged opened this issue May 5, 2023 · 1 comment
Closed

Update CONTRIBUTING.rst #214

neuged opened this issue May 5, 2023 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@neuged
Copy link

neuged commented May 5, 2023

Is your feature request related to a problem? Please describe.

Currently CONTRIBUTING.rst instructs me to run python setup.py to build and test, but there is no setup.py

Describe the solution you'd like

I would like command line examples on how to build/test/lint the project and the documentation locally.

Describe alternatives you've considered

I have looked at setup.cfg and pyproject.toml. I see that the build tool is flit. I can make up a venv and run flit install --deps all, but then pytest still fails with No module named 'selenium'. I can sort of get a sphinx build of the documentation running with sphinx-build -b html docs /tmp/test but that doesn't pull in the code commentary correctly.

codingjoe added a commit that referenced this issue May 5, 2023
@codingjoe codingjoe added bug Something isn't working documentation Improvements or additions to documentation labels May 5, 2023
@codingjoe codingjoe self-assigned this May 5, 2023
@codingjoe
Copy link
Owner

Thanks for alerting me about this. I rewrote this bit, to reflect the modern packaging setup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants