Documentation is built and published on readthedocs

Tasks

  • Add basic sphinx setup
  • Connect to readthedocs: https://ade-cli.readthedocs.io/en/6-documentation-is-built-and-published-on-readthedocs/ once merged https://ade-cli.readthedocs.io/ should work as well
  • Add CI job to test building documentation
  • Add initial set of documentation
    • Installation instructions
    • Changelog
    • About ADE
    • Usage
  • Add advanced topics
    • Include default ade entrypoint to be used for base images
    • Document how to create ade base image
    • Document how to create volume image
    • Document entrypoint features
    • Document configuration
    • Document macvlan network setup and usage from #4 (closed)
      docker network create -d macvlan --subnet=SUBNET --gateway=GATEWAY -o parent=INTERFACE pub_net
      ade start -- --net=pub_net --ip=IP
    • Document publishing of ports
    • Document mounting USB devices
Edited Mar 16, 2019 by Juan Pablo Samper
Assignee Loading
Time tracking Loading