𝚫 Entaldocs

Entalpic's Development Guidelines

CLI

Use entaldocs to initialize a documentation infrastructure in your current codebase. Refer to the docs for usage [WIP].

Contributing

Using uv:

1. Clone this repository
2. $ uv sync
3. Build docs locally with cd docs; make clean && make html
4. Open docs/build/html/index.html

(Read The Docs to come)

That's it 🤓

Status 🏗️

This is still very WIP. In particular, next steps:

• Document entaldocs usage
• Update Contribution Guide
• Add ReadTheDocs deployment instructions