rust-pip
rust-pip copied to clipboard
Rust-Python-Packaging
Create documentation template using mdbook
Created a general template for future API documentation, tutorials, etc...
I have an important thing at work tomorrow and a few job interviews on Tue. So I'm probably gonna check this out on Wed, sorry for delay. Also you can add a GitHub actions ci job in the same PR if you want
No worries! All the best(: Could I clarify what the CI job would/should do? Are you referring to something like this: https://github.com/marketplace/actions/mdbook-action#getting-started?
No worries! All the best(: Could I clarify what the CI job would/should do? Are you referring to something like this: https://github.com/marketplace/actions/mdbook-action#getting-started?
I'm talking about creating a GitHub Actions CI job that triggers when someone pushes to develop and hosts the mdbook using GitHub io
Quick suggestion: you should probably add guide/book to the gitignore, since you don't want to push all the built artifacts to version control every time.
Quick suggestion: you should probably add
guide/bookto the gitignore, since you don't want to push all the built artifacts to version control every time.
Hey @dawnofmidnight! Correct me if I'm wrong but won't that mean no one else would have a copy of the book?
Quick suggestion: you should probably add
guide/bookto the gitignore, since you don't want to push all the built artifacts to version control every time.Hey @dawnofmidnight! Correct me if I'm wrong but won't that mean no one else would have a copy of the book?
The typical workflow for mdbook is for your to only commit the source (markdown) files to git. People should build their own html version locally.