libsession-util/docs/api/README.md

Documentation Website

Getting Started

Writing Documentation

The api-to-markdown.py script parses specially formatted docstring comments to generate API documentation. We parse the file looking for /// comment blocks beginning with /// API: <category>/<name>. You can read more about the format in the script itself.

Install dependencies

pip install -r requirements.txt

Building

Building happens in the dist directory.

# Build libsession-util C API functions
make build-h

# Build libsession-util C++  API functions
make build-cpp

# Build both C and C++ API functions
make build-all

Hosting

# Serve libsession-util C API functions on localhost:8000
make serve-c

# Serve libsession-util C++ API functions on localhost:8001
make serve-cpp

Developing

Warning

Any changes to dist directory will be hot-reloaded but are not tracked by git.

# Serve libsession-util C API functions on localhost:8000
make dev-c

# Serve libsession-util C++ API functions on localhost:8000
make dev-cpp

Resources

• Material for MkDocs
• MkDocs