Luma: Modern Python documentation
Luma is a better way to write Python documentation. It's a modern replacement for Sphinx that's built on the same tooling Stripe uses for their documentation.
Here are the key benefits of Luma:
- Easy to use. Markdown-native and simple to configure. Avoid Sphinx’s obscure syntax.
- Iterate rapidly. Built-in development server and publishing. No need to set up hosting.
- Built for Python. Automatically generate function and class references with seamless cross-referencing.
Getting started
Install Luma
To install Luma, install the package from PyPI:
pip install luma-docs
Create a new Luma project
Once you've installed Luma, run the init
command, and answer the prompts:
luma init
After running the command, you'll see a docs/
folder in your current working directory.
Run the development server
cd
into the docs/
folder, and run the dev
command to start the local development server. Then, open the printed address in your browser. The address is usually http://localhost:3000/
.
cd docs luma dev
Hit Ctrl + C
to stop the development server.
Publish your documentation
Join our Discord to acquire an API key. Then, run the deploy
command to publish your documentation.
luma deploy
After a minute, your documentation will be accessible at https://{your-package}.luma-docs.org
.