theochem
Fix linters and installation using editable mode
This issue fixed the ruff errors. I left it as a pull-request in case it might mess up with merging with other pull-requests. It is also meant to test github actions. I commented out two tests so that the tests pass, see issue #152 for information about the two tests, these tests have been fixed and now pass.
Checklist
- [x ] Write a good description of what the PR does.
- [ ] Rebase onto master
Type of Changes
| Type | |
|---|---|
| ✓ | :hammer: Refactoring |
Related
@marco-2023 @Ali-Tehrani I assume this fix should solve the problem with automatic update of the website.
@marco-2023 Hi Marco, there is also instructions on how to build the website locally on your own computer, see here.
@Ali-Tehrani @marco-2023 there is no need to do anything regarding the website build and deployment. building documentation and deployment is run automatically using GitHub actions here: https://github.com/theochem/gbasis/blob/master/.github/workflows/main.yml
- Documentation is build using the sphinx: https://github.com/theochem/gbasis/blob/f0ad9db12d7b4adc3b0d4fd3dbc31356ee0f9a3b/.github/workflows/main.yml#L48
- Website is build using the Jupyter book: https://github.com/theochem/gbasis/blob/f0ad9db12d7b4adc3b0d4fd3dbc31356ee0f9a3b/.github/workflows/main.yml#L53
- And website is deployed using the ghpages https://github.com/theochem/gbasis/blob/f0ad9db12d7b4adc3b0d4fd3dbc31356ee0f9a3b/.github/workflows/main.yml#L60
I meant it before deployment, if you need to check the added docstrings and formulas look and formatted correctly before merging a pull-request. From what I understand, deployment only occurs when the pull-request gets merged, and not while the pull-request is running, as forked repositories don't have write permissions.
You are right, but I'm feeling like pushing things into ghpages branch manually may create issues with the website, especially when multiple people are working at the same time.
I think the safer option would be to just open file ./website/_build/html/index.html after running jupyter-book build ./website/
This will render the website exactly like it would look like deployed, but no need to push anything on gh-pages branch
Okay, finally all of the tests and linters are working. I think it's ready to be merged and may take the executive decision to do it later, so that others can install using editable mode. Although I'm worried that it may add too much merge conflicts to others
@RichRick1 I completely agree with you on this and was not intending for it to be pushed to the gh-pages but only created locally.
If you're worried about other people that have admin access, mistakenly updating it then sure.