1Bumble Documentation 2==================== 3 4The documentation consists of a collection of markdown text files, with the root of the file 5hierarchy at `docs/mkdocs/src`, starting with `docs/mkdocs/src/index.md`. 6You can read the documentation as text, with any text viewer or your favorite markdown viewer, 7or generate a static HTML "site" using `mkdocs`, which you can then open with any browser. 8 9# Static HTML With MkDocs 10 11[MkDocs](https://www.mkdocs.org/) is used to generate a static HTML documentation site. 12The `mkdocs` directory contains all the data (actual documentation) and metadata (configuration) for the site. 13`mkdocs/requirements.txt` includes the list of Python packages needed to build the site. 14`mkdocs/mkdocs.yml` contains the site configuration. 15`mkdocs/src/` is the directory where the actual documentation text, in markdown format, is located. 16 17To build, from the project's root directory: 18``` 19$ mkdocs build -f docs/mkdocs/mkdocs.yml 20``` 21 22You can then open `docs/mkdocs/site/index.html` with any web browser. 23