Contributing

For development use the fork the repo on github, then run

git clone https://github.com/<your-username>/.git
cd pymgcv
pixi shell -e dev  # activates the devlopment env

Testing

Run tests with:

pytest

Documentation

The documentation includes notebook examples in docs/examples. To rerun all these prior to building the docs, run

pixi run notebooks

We can locally serve the docs using

mkdocs serve

Adding code examples in docstrings

In order for the doctest to run properly, and documentation to be generated properly:

• Use the admonition !!! example, containing a python fenced code block, i.e.:

  !!! example
  
      ```python
      # Insert runnable example here
      ```
  

• Do not use a prompt >>> as this interferes with copying code blocks and looks cluttered!
• We generally do not test the output, just that each example runs (although you could use an assert if desired)
• Use a comment at the bottom if you want to show an output example