Document how to generate docs
This commit is contained in:
parent
e77c40e27c
commit
3cb548ae3a
3 changed files with 49 additions and 1 deletions
|
@ -7,7 +7,8 @@
|
||||||
- [Advanced](advanced.md)
|
- [Advanced](advanced.md)
|
||||||
- [TUI](tui.md)
|
- [TUI](tui.md)
|
||||||
- [Contributing](contributing.md)
|
- [Contributing](contributing.md)
|
||||||
|
- [Documentation](documentation.md)
|
||||||
|
- [Release procedure](release.md)
|
||||||
- [Changelog](changelog.md)
|
- [Changelog](changelog.md)
|
||||||
- [Release procedure](release.md)
|
|
||||||
|
|
||||||
[License](license.md)
|
[License](license.md)
|
||||||
|
|
38
docs/documentation.md
Normal file
38
docs/documentation.md
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
Documentation is generated using [mdBook](https://rust-lang.github.io/mdBook/).
|
||||||
|
|
||||||
|
Documentation is written in markdown and located in the `docs` directory.
|
||||||
|
|
||||||
|
Additional plugins:
|
||||||
|
|
||||||
|
- [mdbook-toc](https://github.com/badboy/mdbook-toc)
|
||||||
|
|
||||||
|
Install prerequisites
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
You'll need a moderately recent version of Rust (1.60) at the time of writing.
|
||||||
|
Check out [mdbook installation docs](https://rust-lang.github.io/mdBook/guide/installation.html)
|
||||||
|
for details.
|
||||||
|
|
||||||
|
Install by building from source:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo install mdbook mdbook-toc
|
||||||
|
```
|
||||||
|
|
||||||
|
Generate
|
||||||
|
--------
|
||||||
|
|
||||||
|
HTML documentation is generated from sources by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
mdbook build
|
||||||
|
```
|
||||||
|
|
||||||
|
To run a local server which will rebuild on change:
|
||||||
|
|
||||||
|
```
|
||||||
|
mdbook serve
|
||||||
|
```
|
|
@ -32,3 +32,12 @@ GitHub release
|
||||||
* wheel distribution (.whl)
|
* wheel distribution (.whl)
|
||||||
|
|
||||||
TODO: this can be automated: https://developer.github.com/v3/repos/releases/
|
TODO: this can be automated: https://developer.github.com/v3/repos/releases/
|
||||||
|
|
||||||
|
Update documentation
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
To regenerate HTML docs and deploy to toot.bezdomni.net:
|
||||||
|
|
||||||
|
```
|
||||||
|
make docs-deploy
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue