6858c591aa
Bumps the pip group with 1 update in the /docs/mkdocs directory: [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions). Updates `pymdown-extensions` from 10.0 to 10.16.1 - [Release notes](https://github.com/facelessuser/pymdown-extensions/releases) - [Commits](https://github.com/facelessuser/pymdown-extensions/compare/10.0...10.16.1) --- updated-dependencies: - dependency-name: pymdown-extensions dependency-version: 10.16.1 dependency-type: direct:production dependency-group: pip ... Signed-off-by: dependabot[bot] <support@github.com>
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 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.