diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index 07bae4e..0000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: ci -on: - push: - branches: - - documentation # TODO change this to main when this PR is approved -permissions: - contents: write -jobs: - build-and-deploy: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: install protobuf-compiler - run: sudo apt install -y protobuf-compiler - - uses: actions/setup-go@v4 - with: - go-version: '>=1.17.0' - - name: install protoc-gen-doc - # TODO use this command instead when the PR is merged - # https://github.com/pseudomuto/protoc-gen-doc/pull/522 - # run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest - run: | - cd ${{github.workspace}} - wget https://github.com/aristanetworks/protoc-gen-doc/archive/refs/heads/feat/separate-files.zip - unzip separate-files.zip - cd protoc-gen-doc-feat-separate-files - make build - - name: generate markdown files from comments - # TODO remove the first argument line when the PR is merged - run: | - protoc \ - --plugin=protoc-gen-doc=${{github.workspace}}/protoc-gen-doc-feat-separate-files/bin/protoc-gen-doc \ - -I${{github.workspace}}/proto \ - --doc_out=${{github.workspace}}/docs/api-reference \ - --doc_opt=${{github.workspace}}/.github/templates/api-reference-md.tmpl,md,default,separate_files \ - ${{github.workspace}}/proto/*.proto - - uses: actions/setup-python@v4 - with: - python-version: 3.x - - run: pip install mkdocs-material mkdocs-awesome-pages-plugin mdx_truly_sane_lists - - run: mkdocs gh-deploy --force diff --git a/README-dev.md b/README-dev.md index f09978a..d0cbf5f 100644 --- a/README-dev.md +++ b/README-dev.md @@ -15,10 +15,10 @@ The downloaded files should then be unzipped to `docs/api-reference/`. The websi │ ├── 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 -│ ├── ci.yml # Workflow for both generating documentation and deploying the site │ ├── 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