Fixes developer guide #887
Conversation
|
The tests fail due to a timeout. I don't expect to do more here before the review. |
|
Happy to merge this for the time being but will want to revert once libmamba is the default for conda. |
| $ doit list | ||
| build_docs build docs | ||
| develop_install python develop install, with specified optional groups of dependencies (installed by conda only). | ||
| ecosystem_setup Common conda setup (must be run in base env). | ||
| env_capture Report all information required to recreate current conda environment | ||
| env_create Create named environment if it doesn't already exist | ||
| env_dependency_graph Write out dependency graph of named environment. | ||
| env_export Generate a pinned environment.yaml from specified env, filtering | ||
| env_export2 | ||
| list_envs | ||
| miniconda_download Download Miniconda3-latest | ||
| miniconda_install Install Miniconda3-latest to location if not already present | ||
| package_build Build and then test conda.recipe/ (or specified alternative). | ||
| package_test Test existing package | ||
| package_upload Upload package built from conda.recipe/ (or specified alternative). | ||
| pip_on_conda Experimental: provide pip build env via conda | ||
| test_all Run all tests | ||
| test_examples Test that default examples run | ||
| test_flakes Flake check python and notebooks | ||
| test_unit Run unit tests with coverage |
There was a problem hiding this comment.
Note to myself, this is not very useful as contributors won't use most of these commands. Documenting doit could be done on the HoloViz site, not even sure we want to do that really.
There was a problem hiding this comment.
I put it in because currently most of the info on how to build, serve or test stuff is not documented. So this is the best there is to my knowledge.
It might be obvious to you how to do this. But an outsider like me, not having access to a colleague with the knowledge etc have no chance of figuring out how to build or view the docs currently for example. Before seeing this list I did not know how to run flakes test as I normally don't do that. I could spend the time figuring out. But its friction and I might get it wrong.
There was a problem hiding this comment.
There will be soon a contributing guide that should make more of this knowledge available to everyone: holoviz/holoviz#323
In the mean time, the source of truth for running the tests/building the docs/building the packages are the Github Action Workflows.
Addresses