This is the source code for public documentation about OSMO. The documentation generates both a static HTML website and markdown files.

Run the following command to install doc dependencies:

pip install -r locked_requirements.txt

You can build the docs by running the following in this directory:

make build

Then you can open the generated HTML and markdown files in your browser. You can find the generated files in ~/path/to/osmo/docs/_build/public/. The public/ directory includes:

• out/ - The generated HTML and markdown files
• err/ - Any warnings or errors produced by the build process

Check if there are any misspelled words with:

make spelling