mirror of
https://github.com/google/bumble.git
synced 2026-04-16 00:25:31 +00:00
c2959dadb4
Squashed commits: [cd479ba] formatting and linting automation [7fbfabb] formatting and linting automation [c4f9505] fix after rebase [f506ad4] rename job [441d517] update doc (+7 squashed commits) [2e1b416] fix invoke and github action [6ae5bb4] doc for git blame [44b5461] add GitHub action [b07474f] add docs [4cd9a6f] more linter fixes [db71901] wip [540dc88] wip
23 lines
1.0 KiB
Markdown
23 lines
1.0 KiB
Markdown
Bumble Documentation
|
|
====================
|
|
|
|
The documentation consists of a collection of markdown text files, with the root of the file
|
|
hierarchy at `docs/mkdocs/src`, starting with `docs/mkdocs/src/index.md`.
|
|
You can read the documentation as text, with any text viewer or your favorite markdown viewer,
|
|
or generate a static HTML "site" using `mkdocs`, which you can then open with any browser.
|
|
|
|
# Static HTML With MkDocs
|
|
|
|
[MkDocs](https://www.mkdocs.org/) is used to generate a static HTML documentation site.
|
|
The `mkdocs` directory contains all the data (actual documentation) and metadata (configuration) for the site.
|
|
`mkdocs/requirements.txt` includes the list of Python packages needed to build the site.
|
|
`mkdocs/mkdocs.yml` contains the site configuration.
|
|
`mkdocs/src/` is the directory where the actual documentation text, in markdown format, is located.
|
|
|
|
To build, from the project's root directory:
|
|
```
|
|
$ mkdocs build -f docs/mkdocs/mkdocs.yml
|
|
```
|
|
|
|
You can then open `docs/mkdocs/site/index.html` with any web browser.
|