README.md

𝚫 Entaldocs

Entalpic's Development Guidelines

CL

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

Installation

uv tool install git+ssh://[email protected]/entalpic/entaldocs.git

Upgrade

uv tool upgrade entaldocs

See Usage instructions in the online docs.

Contributing

Using uv:

1. Clone this repository

   git clone git+ssh://[email protected]/entalpic/entaldocs.git
   # or
   gh repo clone entalpic/entaldocs
   
   # then
   cd entaldocs

2. $ uv sync

3. Build docs locally with entaldocs build-docs

4. Open docs/build/html/index.html

That's it 🤓

Status 🏗️

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

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