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

Improve doc generation #1639

Open
appetrosyan opened this issue Nov 26, 2021 · 2 comments
Open

Improve doc generation #1639

appetrosyan opened this issue Nov 26, 2021 · 2 comments
Assignees
Labels
iroha2-dev The re-implementation of a BFT hyperledger in RUST

Comments

@appetrosyan
Copy link
Contributor

appetrosyan commented Nov 26, 2021

Right now the documentation is only generated for configuration parameters, and done very inefficiently.

It's possible to generate the docs as we do right now using cargo doc which would avoid having to compile and link the entirety of Iroha, just to generate the documentation.

@appetrosyan appetrosyan added the iroha2-dev The re-implementation of a BFT hyperledger in RUST label Nov 26, 2021
@e-ivkov
Copy link
Contributor

e-ivkov commented Nov 26, 2021

I think the best way is to publish static website with GitHub Pages for docs for dev branch. For releases we will just publish the crate with cargo publish then the docs will be automatically available at docs.rs

@appetrosyan appetrosyan added the Documentation Documentation changes label Jan 10, 2022
@appetrosyan appetrosyan removed the Documentation Documentation changes label Apr 28, 2022
@0x009922
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

No branches or pull requests

5 participants