executablebooks / sphinx-exercise

A Sphinx extension for producing exercise and solution directives.
https://ebp-sphinx-exercise.readthedocs.io
MIT License
18 stars 6 forks source link

[Docs] Write up developer documentation #41

Open mmcky opened 2 years ago

mmcky commented 2 years ago

Description / Summary

Need to write up lessons learnt with integrating custom admonitions to support:

  1. integration with ref and numref
  2. setting up directives
  3. working with post_transforms
  4. working with transforms

Value / benefit

This will help with some more general docs for writing extensions for sphinx that could be of value to the executable books community

Implementation details

No response

Tasks to complete

No response