The API reference is not source controlled in this repository as it gets auto-generated by the GitHub CI.
After each CI run, all documentation files generated from protofiles are uploaded.
They can be retrieved from the GitHub UI.
The downloaded files should then be unzipped to docs/api-reference/. The website can then be re-run.
.
├──.github # Standardized directory for github-related config files
│ ├── templates # Templates used by our custom github workflows
│ │ └── api-reference-md.tmpl # Custom output doc template used by proto-gen-doc
│ └── workflows # Standardized github actions workflows directory
│ ├── deploy-website.yml # Workflow for deploying the site using MkDocs after generating proto docs
│ └── generate-api-reference.yml # Workflow for generating docs from proto files using proto-gen-doc
├── README.md
├── README-dev.md
├── docs # Documentation and guides relating to the use of EosSdkRpc
│ ├── api-reference # MkDocs api reference information
│ ├── assets # Additional assets including the Arista favicon
│ ├── guide # All EosSdkRpc guides on EosSdkRpc recommended practices and setup
│ └── *
├── mkdocs.yml # MkDocs configuration settings including name, theme, extensions etc
├── proto # All publically availble proto files for EosSdkRpc clients
└── requirements.txt # Python requirements file for this project