Your project documentation

Next steps

If you want to include this documentation as a sub-documentation in another repository, add the following line to the mkdocs_custom.yml of the other repository.

cd submodules
git submodule add your-repo-name

- Your project documentation: '!include ./submodules/your-repo-name/mkdocs.yml'

Reference

• Markdown/Material for MkDocs: https://squidfunk.github.io/mkdocs-material/reference/
• Snippets: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

---

Testing framework

For writing tests that run Netlab labs locally or via the Remote Lab server, see the Testing Framework guide under Development: ./development/10-setting_up_pytest/

Device Connections

For connecting to network devices in function blocks, start with the Device Connections series:

• ./development/30-device-connections.md (concepts)
• ./development/31-connection-methods.md (usage & lifecycle)
• ./development/32-method-resolution-priority.md (resolution, defaults, ambiguity)
• ./development/33-writing-capabilities-and-proxies.md (capabilities & proxy fallbacks)
• ./development/34-writing-base-plugins.md (new library support)
• ./development/35-platform-plugins-and-defaults.md (platform plugin examples)
• ./development/36-capability-proxy-architecture.md (capability interface & proxy architecture)

For API documentation, see: Connection Module API