Skip to content

PDoc for Docs#55

Open
verdakode wants to merge 2 commits into
masterfrom
verdakode-patch-1
Open

PDoc for Docs#55
verdakode wants to merge 2 commits into
masterfrom
verdakode-patch-1

Conversation

@verdakode
Copy link
Copy Markdown

@verdakode verdakode commented Mar 17, 2025

WIP

@verdakode
Copy link
Copy Markdown
Author

someone needs to add this token as a secret in the kscalelabs/kos repository:

  • go to the repository settings
  • navigate to Settings > Secrets and variables > Actions
  • add a new repository secret named DOCS_REPO_PAT with your token value

@verdakode verdakode requested a review from jingxiangmo March 17, 2025 20:53
@jingxiangmo
Copy link
Copy Markdown

jingxiangmo commented Mar 17, 2025

Please use PDoc to generate markdown

@jingxiangmo jingxiangmo changed the title Create sync_docstrings.yml PyDocs for Docs (WIP) Mar 17, 2025
Comment thread .gitignore Outdated
Comment on lines +3 to +4
kos/proto/googleapis/google/.DS_Store
.DS_Store
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i believe you can just do

*.DS_Store

@jingxiangmo jingxiangmo changed the title PyDocs for Docs (WIP) PDoc for Docs (WIP) Mar 17, 2025
Comment thread .github/workflows/publish.yml Outdated
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
run: |
cargo publish -p kos
update-api-docs:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's move this to a separate yaml so we have more control over the triggers

@verdakode verdakode requested a review from WT-MM April 6, 2025 00:59
@verdakode verdakode changed the title PDoc for Docs (WIP) PDoc for Docs Apr 6, 2025
@verdakode verdakode requested a review from codekansas April 7, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants