search

aleph-im / aleph-docs

Aleph.im Official Documentation (Work in progress)
https://docs.aleph.im/
MIT License
6 stars 8 forks source link

Added generated docs for the aleph CLI v0.6.1 #75

Closed MHHukiewitz closed 6 months ago

MHHukiewitz commented 6 months ago

Using typer __main__.py utils docs in aleph-client: https://typer.tiangolo.com/typer-cli/#generate-docs-with-typer-cli

github-actions[bot] commented 6 months ago

Deployed (not pinned) on:

github-actions[bot] commented 6 months ago

Deployed (not pinned) on:

github-actions[bot] commented 6 months ago

Deployed (not pinned) on:

github-actions[bot] commented 6 months ago

Deployed (not pinned) on:

github-actions[bot] commented 6 months ago

Deployed (not pinned) on:

MHHukiewitz commented 6 months ago

All things easily addressible were fixed, others need either changes to the Aleph CLI or add some automation to make the generated docs adhere to our standards.

hoh commented 6 months ago

Nice work !

Can we rename tools/aleph-client/documentation/ into tools/aleph-client/usage ?

hoh commented 6 months ago

Is there an easy way to rebuild that doc or have it built automatically ?

aleph docs > ./docs/tools/aleph-client/usage.md or something similar ?

MHHukiewitz commented 6 months ago

There are multiple fixes contained in this, which could be automated:

But the way to do it now is

typer .src/aleph-message/__main__.py utils docs
github-actions[bot] commented 6 months ago

Deployed (not pinned) on: