Comments (4)
@John15321 Hey John! Just want to clarify the difference between this and and writing comments in the code and running
cargo doc
Also, do I just create the general structure first or is there already information you would like to be inside?
Thanks!
You can watch the first 17 minutes to get a better understanding.
In short the documentation generated by cargo doc
is a so called API documentation or reference documentation or whatever people like to call it. It's minimalistic and purely based on the source code. On the other hand the one by mdbook is meant to be more abstract and fully carted to a human reader. It should perform the role of a usage guide, a guide in general, etc
You can look at the cargo-generate
project to get a feel
from rust-pip.
I'll work on this! Will get it done by this week.
from rust-pip.
I'll work on this! Will get it done by this week.
Thanks. No rush, its not a race. Noone is trying to chase us with their own rewrite of pip in Rust, the point is to do this right not fast ;)
from rust-pip.
@John15321 Hey John! Just want to clarify the difference between this and and writing comments in the code and running cargo doc
Also, do I just create the general structure first or is there already information you would like to be inside?
Thanks!
from rust-pip.
Related Issues (20)
- Add macOS and windows testing in the CI/CD piplines
- Add release cycle workflows
- Add a `CHANGELOG` file HOT 2
- Add a CI job to ensure that `CHANGELOG` is updating in a PR HOT 1
- Add the `CHANGELOG` file to the documentation of the project
- Add a documentation generating CI job
- Add status CI badges to the `README` HOT 1
- Add strategy matrix to the building and testing CI jobs for all three toolchain channels
- Add Markdown Linting CI Job HOT 1
- Add a `.deb` release to the release file
- Add an `arch` release to the release file
- Add an `arch` release to the release file
- Add a `.rpm` release to the release file
- Add code coverage checking CI job
- Add an `a-pack` release file (package format for Alpine)
- Add a `rust-pip` docker image
- Add a markdownlint job to the Makefile.toml (cargo-make)
- Using dependabot HOT 2
- Add `cargo-audit` job to the CI
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rust-pip.