Luma is 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.
Key benefits of Luma:
- Markdown-native: Avoid Sphinx’s obscure syntax.
- Built for Python: API generation and cross-referencing work out-of-the-box.
- Live rendering: Preview your changes as you write.
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file luma_docs-0.0.14.tar.gz.
File metadata
- Download URL: luma_docs-0.0.14.tar.gz
- Upload date:
- Size: 246.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.8.4 CPython/3.12.4 Darwin/23.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d9d47e1722c02548f3bfed10929ec7112e61428660f916245f15367e3b6a2be
|
|
| MD5 |
0055f262f750be77dab8f13e93495d04
|
|
| BLAKE2b-256 |
7b67d712393d138afd2a2bc70dc6633a31ecd659de79a2fb90ac339e6c5fd51e
|
File details
Details for the file luma_docs-0.0.14-py3-none-any.whl.
File metadata
- Download URL: luma_docs-0.0.14-py3-none-any.whl
- Upload date:
- Size: 263.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.8.4 CPython/3.12.4 Darwin/23.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
877da3d426b4e2063952f9daad95ff7dfdc8e9770afba5a7a2fd07a3a03badbf
|
|
| MD5 |
c2f7923c23343093a12d17dba3b90294
|
|
| BLAKE2b-256 |
70449f287c7fabd4a82d935aaf44dd6786bb11cdb152a08d3608c1543542a179
|
