Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(all): integrated documentation using canonical MkDocs template #2726

Merged
merged 4 commits into from
Oct 4, 2023
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
36 changes: 36 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: CC-BY-4.0

name: Deploy Docs (Github Pages)

on:
push:
branches:
- main
paths:
- 'docs/**'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

- name: Use Python 3.x
uses: actions/setup-python@v4
with:
python-version: '3.10'
cache: 'pip' # caching pip dependencies

- name: Install dependencies
run: pip install -r requirements.txt
working-directory: docs

- name: Build and publish
run: git pull && mkdocs gh-deploy
working-directory: docs
14 changes: 7 additions & 7 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ Maintainers
| Name | GitHub | Chat |
|------|--------|------|
| Jonathan Hamilton | [jonathan-m-hamilton][jonathan-m-hamilton] | JHamilton |
| Izuru Sato | [izuru0][izuru0] | Izuru Sato#6434 |
| Peter Somogyvari | [petermetz][petermetz] | peter_somogyvari#3365 |
| Takuma TAKEUCHI | [takeutak][takeutak] | takeutak#7220 |
| Izuru Sato | [izuru0][izuru0] | izurusato |
| Peter Somogyvari | [petermetz][petermetz] | peter_somogyvari |
| Takuma TAKEUCHI | [takeutak][takeutak] | takeutak |
| Jagpreet Singh Sasan | [jagpreetsinghsasan][jagpreetsinghsasan] | jagpreetsinghsasan |
| Venkatraman Ramakrishna | [VRamakrishna][VRamakrishna] | Ramakrishna#6645 |
| Sandeep Nishad | [sandeepnRES][sandeepnRES] | sandeepn#1092 |
| Venkatraman Ramakrishna | [VRamakrishna][VRamakrishna] | vramaiitkgp |
| Sandeep Nishad | [sandeepnRES][sandeepnRES] | sandeepn |

[jonathan-m-hamilton]: https://github.com/jonathan-m-hamilton
[izuru0]: https://github.com/izuru0
[petermetz]: https://github.com/petermetz
[takeutak]: https://github.com/takeutak
[jagpreetsinghsasan]: https://github.com/jagpreetsinghsasan
[VRamakrishna]: https://github.com/VRamakrishna/
[sandeepnRES]: https://github.com/sandeepnRES
[VRamakrishna]: https://github.com/VRamakrishna
[sandeepnRES]: https://github.com/sandeepnRES
File renamed without changes.
7 changes: 7 additions & 0 deletions docs-cactus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Building the docs
```sh
pip install -U Sphinx
pip install -r pip-requirements.txt
make html
```
Access the documents from **build/html/** folder.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site/
1 change: 1 addition & 0 deletions docs/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @VRamakrishna
Loading
Loading