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
added 19 commits
-
17cd5dd2...514c2fe0 - 3 commits from branch
master - 514c2fe0...0662dd9e - 6 earlier commits
- 815fb0d1 - use only polkadot-sdk from duniter
- 89c8f444 - fix xtask gen-docs
- 7dda9e8e - remove gen-doc file from git index
- 40b35820 - add rust doc generation
- e85adf1b - add url to rust autogenerated docs in api
- 3400991c - enable full docs for non-local pallet
- 6955177c - add base url
- 1334ca4e - move runtime api doc to target artefact
- e93fb968 - reduce doc size
- 7f086905 - add doc to CI
Toggle commit list-
17cd5dd2...514c2fe0 - 3 commits from branch
mentioned in merge request !258 (merged)
added 2 commits
Since !258 (merged), the descriptions of the calls are back in the metadata, which will fix issues #217 (closed) and #183 (closed). I have restored the generated API documentation in the git history, as it is now complete and can be hosted and consulted in the git repository. I have retained the complete Rust documentation generation part of the
xtask gen-doccommand so that the full documentation can be easily generated and hosted somewhere if it is relevant.Edited by Benjamin Gallois
mentioned in issue clients/cesium-grp/cesium2s#14 (closed)
added 14 commits
-
4e634113...a3273d23 - 2 commits from branch
master - a3273d23...1b39ab2a - 2 earlier commits
- 1b19d7bc - add rust doc generation
- 00c864a1 - add url to rust autogenerated docs in api
- 4d6d5145 - enable full docs for non-local pallet
- 6520a174 - add base url
- b71f715b - move runtime api doc to target artefact
- 4c06e37b - reduce doc size
- 122ec00e - add doc to CI
- 524a41a6 - update xtask to polkadot-v1.9.0
- c1d94fa5 - Revert "add doc to CI"
- c963d045 - revert gen-doc changes
Toggle commit list-
4e634113...a3273d23 - 2 commits from branch
-
On est à 225 Mo maintenant, ça a un peu gonflé depuis les 174 Mo de !254 (comment 42451).
> du -sh target/doc 225M target/docJe l'ai mis sur mon nœud IPFS et je pense que c'est même mieux que que ce passer par une CI: http://bafybeidjf4gr2d5lortc5shji3vnchzkwewvjaxwkes327vdetdruoo6fy.ipfs.subgateway.datapod.coinduf.eu/pallet_identity/enum.IdtyStatus.html (il me manque un wildcard sur ma gateway et peut-être domaine mieux pour faire du DNSlink).
mentioned in commit 2b050e27
mentioned in issue #217 (closed)
