Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 26 additions & 9 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,36 @@ name: docs

on:
push:
branches:
- main
tags:
- 'v*'
pull_request:
branches:
- main

permissions:
contents: write

jobs:
docs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: compas-dev/compas-actions.docs@v4
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
doc_url: https://gramaziokohler.github.io/compas_pb
python-version: 3.x

- name: Install dependencies
run: |
pip install -e .[docs]

- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com

- name: Generate Protobuf Docs
run: |
invoke proto_docs

- name: Deploy to GitHub Pages
run: |
mike deploy --push --update-aliases ${{ github.ref_name }} latest
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

* Migrated the documentation website to MkDocs Material from Sphinx.

### Removed


Expand Down
1 change: 0 additions & 1 deletion docs/_images/PLACEHOLDER

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api.rst

This file was deleted.

75 changes: 0 additions & 75 deletions docs/api/compas_pb.conversions.rst

This file was deleted.

24 changes: 0 additions & 24 deletions docs/api/compas_pb.core.rst

This file was deleted.

17 changes: 0 additions & 17 deletions docs/api/compas_pb.registry.rst

This file was deleted.

21 changes: 0 additions & 21 deletions docs/api/compas_pb.rst

This file was deleted.

5 changes: 5 additions & 0 deletions docs/assets/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:root > * {
--md-primary-fg-color: #0092d2;
--md-primary-fg-color--light: #0092d2;
--md-primary-fg-color--dark: #0092d2;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/compas_pb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/images/compas_pb.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CHANGELOG.md"
160 changes: 0 additions & 160 deletions docs/conf.py

This file was deleted.

Loading