Skip to content
Snippets Groups Projects
Verified Commit 4f91ee87 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

Merge branch 'dev' into f-filesystem-cleanup

parents 223e4481 fd4263b6
No related branches found
No related tags found
2 merge requests!83Draft: file system: cleanup,!58F filesystem
Pipeline #31688 passed
......@@ -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).
......
......@@ -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.
[pytest]
testpaths=unittests
addopts=-x -vv --cov=caosdb
......@@ -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',
......
......@@ -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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment