diff --git a/README.md b/README.md index 602df33cecfc8ec37fd791e3257221e66f120cb3..7215591a4f31f1946029442de291eb9ccf9beea1 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ By participating, you are expected to uphold our [Code of Conduct](https://gitla * If you have a suggestion for the [documentation](https://docs.indiscale.com/caosdb-pylib/), the preferred way is also a merge request as describe above (the documentation resides in `src/doc`). However, you can also create an issue for it. -* You can also contact us at **info (AT) caosdb.de** and join the +* You can also contact us at **info (AT) caosdb.org** and join the CaosDB community on [#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). diff --git a/README_SETUP.md b/README_SETUP.md index 48928d6c3f2c878a8d8b268b36ed2cdeba7f8014..01eea85188078ae6f2fe226e89e5c227497b4bd0 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -109,6 +109,8 @@ Now would be a good time to continue with the [tutorials](tutorials/index). - Run a specific test function: e.g. `tox -- unittests/test_schema.py::test_config_files` ## Documentation ## +We use sphinx to create the documentation. Docstrings in the code should comply +with the Googly style (see link below). Build documentation in `build/` with `make doc`. @@ -118,5 +120,11 @@ Build documentation in `build/` with `make doc`. - `sphinx-autoapi` - `recommonmark` +### How to contribute ### + +- [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) +- [Google Style Python Docstrings 2nd reference](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings) +- [References to other documentation](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external) + ### Troubleshooting ### If the client is to be executed directly from the `/src` folder, an initial `.\setup.py install --user` must be called. diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index ca6aad829a3e0607292cf69b8b1d4b7f7758993e..0000000000000000000000000000000000000000 --- a/pytest.ini +++ /dev/null @@ -1,3 +0,0 @@ -[pytest] -testpaths=unittests -addopts=-x -vv --cov=caosdb diff --git a/setup.py b/setup.py index 35d6d69a83338a0dc543b4b6438b56c1372b7237..fca246ed7004a25e7eedc594a4e7eceb68ee295a 100755 --- a/setup.py +++ b/setup.py @@ -174,7 +174,7 @@ def setup_package(): python_requires='>=3.8', package_dir={'': 'src'}, install_requires=['lxml>=4.6.3', - "requests[socks]>=2.28.1", + "requests[socks]>=2.26", "python-dateutil>=2.8.2", 'PyYAML>=5.4.1', 'future', diff --git a/tox.ini b/tox.ini index 50c22d5716769ef2ec818f6c8fb94491ea372434..3b3371a9424cf6692a7c3c05f9c911ffdd34b957 100644 --- a/tox.ini +++ b/tox.ini @@ -12,3 +12,8 @@ commands=py.test --cov=caosdb -vv {posargs} [flake8] max-line-length=100 + +[pytest] +testpaths = unittests +xfail_strict = True +addopts = -x -vv --cov=caosdb