sabledocs

(β˜… 94)

Simple static documentation generator for Protobuf and gRPC contracts.

File Explorer

Download Latest Version (.zip)
  • .gitattributes
  • .gitignore
  • CHANGELOG.md
  • generate_sample_docs.sh
  • LICENSE
  • MANIFEST.in
  • mystyles.css
  • package-lock.json
  • package.json
  • pyproject.toml
  • README.md
  • setup.cfg

# Installation Guide

1. Get the code
git clone https://github.com/markvincze/sabledocs

Downloads the entire project code from GitHub to your computer.

cd sabledocs

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install sabledocs

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f docker/alpine/Dockerfile -t sabledocs .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 sabledocs

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm run css-build; pip install ..; sabledocs; .\output\index.html

Installs the Python libraries listed in requirements.txt (or similar).

npm run css-build && pip install .. && sabledocs && .\output\index.html

Installs the Python libraries listed in requirements.txt (or similar).

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install sabledocs

Installs the package published on PyPI directly β€” no need to clone the source.

python -m build

Runs the Python script (or module).

python -m twine upload --repository testpypi dist/*

Runs the Python script (or module).

pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

npm run css-build; pip install ..; sabledocs; .\output\index.html

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

Today's picks

rtk β˜… 76,925

CLI proxy that reduces LLM token consumption by 60-90% on common dev commands. Single Rust

Rust
computer-science β˜… 208,280

πŸŽ“ Path to a free self-taught education in Computer Science!

HTML
TradingAgents β˜… 99,131

TradingAgents: Multi-Agents LLM Financial Trading Framework

Python
mermaid β˜… 89,874

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner

TypeScript
gin β˜… 89,095

Gin is a high-performance HTTP web framework written in Go. It provides a Martini-like API

Go
open-design β˜… 90,071

🎨 Best DeepSeek Harness Design Plugin. The open-source Claude Design alternative. πŸ–₯️ Local

TypeScript
// repository documentation