Refac generated documentation
Closes #183 (closed) and fixed the xtask gen-doc that was not compiling anymore.
cargo xtask gen-doc will now generate the rust autogenerated documentation (the full (and bloated) documentation is necessary for Substrate pallets calls). The docs/api/runtime-calls.md will be generated with reference to the rust autogenerated documentation based on the BASE_URL variable.
The only thing left to do is to decide where to store the rust autogenerated documentation. Then, a CI with the necessary server permissions can simply run:
BASE_URL="https://url/to/endpoint" cargo xtask gen-doc
rsync -a ./docs/api/doc user@server:/path/to/endpoint/Merge request reports
Activity
changed milestone to %runtime-802
added C-doc P5-sometimesoon labels
assigned to @bgallois
requested review from @HugoTrentesaux
added RN-silent label
Resolved by Benjamin Galloisthe full (and bloated) documentation is necessary for Substrate pallets calls
too bad that we can not have
--no-deps
We can add a "page" entry to the CI (like https://git.duniter.org/websites/duniter_website_fr_v2/-/blob/master/.gitlab-ci.yml?ref_type=heads#L8). And I can then configure them in the admin (like https://git.duniter.org/websites/duniter_website_fr_v2/pages). But for domain name, I'll ask on the forum.
- Last reply by Hugo Trentesaux
-
Je me suis rendu compte que mon intention n'était pas claire dans l'issue (cf commentaire).
Quitte à produire un artefact dans une CI, autant que les fichiers markdown y soient aussi, plutôt que commités sur le dépôt git. Donc il faudrait changer le dossier de sortie par défaut de
docs/apiverstarget/doc, c'est plus logique pour un artefact. added 12 commits
-
a35990f2...3240a1aa - 5 commits from branch
master - 0a3950f6 - fix xtask gen-docs
- e4f12024 - remove gen-doc file from git index
- 5ff53aec - add rust doc generation
- fde309e9 - add url to rust autogenerated docs in api
- 71eecbf8 - enable full docs for non-local pallet
- 09df9b03 - add base url
- 7a234923 - move runtime api doc to target artefact
Toggle commit list-
a35990f2...3240a1aa - 5 commits from branch
