docs-hub
Scans one or more root folders for .html/.md files that live under a
docs/ or reports/ folder (at any depth), converts the Markdown ones to
HTML, and builds a single browsable index grouped by top-level repo/folder.
Runs locally on your own machine only — no hosting, no accounts, no data
leaves your filesystem.
Install
pipx install . # from this directory, or `pipx install docs-hub` once published
# or, in a venv:
pip install .
Quick start
docs-hub config set roots=/path/to/your/projects
docs-hub scan # one-off run
docs-hub ui # http://127.0.0.1:5000 — dashboard, settings, cron
The web UI lets you:
- Dashboard — see last scan info and open the generated index.
- Settings — pick which root folder(s) to scan, which folder names count as "docs"/"reports", and which directories to skip.
- Cron — see whether a scheduled scan is installed, and install/update/
remove it. This writes to your real user crontab, tagged with a
# docs-hub-scanmarker comment so it only ever touches its own job — your other cron jobs are left alone.
Config lives at ~/.config/docs-hub/config.json (or your platform's
config-dir equivalent); generated output lives under
~/.local/share/docs-hub by default.
CLI reference
docs-hub scan [--root PATH ...]
docs-hub ui [--port 5000] [--host 127.0.0.1]
docs-hub config show
docs-hub config set KEY=VALUE [KEY=VALUE ...] # comma-separate list values
docs-hub cron install [--schedule "0 * * * *"]
docs-hub cron remove
docs-hub cron status
Migrating from the old standalone generate.py
This repo previously shipped a single hardcoded script
(generate.py) with a raw crontab entry pointing at it directly. To move to
the packaged version:
pip install -e . # from this directory
docs-hub config set roots=/home/arun/Arun/Projects # restore the old scan target
docs-hub cron install --schedule "0 * * * *" # replaces the raw crontab line
crontab -e # remove the old raw generate.py line by hand
The old converted/, index.html, and cron.log produced by generate.py
are independent of the new package's output directory and can be left in
place or deleted once you've confirmed the new docs-hub scan output looks
right. Note that docs-hub (this folder) itself sits under
/home/arun/Arun/Projects, so it's included in the default
exclude_dirs list to avoid the scanner picking up its own cached output as
a phantom "repo".
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 docs_hub-0.1.3.tar.gz.
File metadata
- Download URL: docs_hub-0.1.3.tar.gz
- Upload date:
- Size: 18.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
46249212dad56d57e6e2496fcd39161ac219d7422b6419373a7fa99beef188c8
|
|
| MD5 |
4081a0cacfd112f9c2f96d4bcdcde8cc
|
|
| BLAKE2b-256 |
5751527eb8af1fe304e7b4b4aa0082885d2482db4988bd0f3be89aa189829ce7
|
Provenance
The following attestation bundles were made for docs_hub-0.1.3.tar.gz:
Publisher:
publish.yml on Arun-gox/docs-hub
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docs_hub-0.1.3.tar.gz -
Subject digest:
46249212dad56d57e6e2496fcd39161ac219d7422b6419373a7fa99beef188c8 - Sigstore transparency entry: 2524259458
- Sigstore integration time:
-
Permalink:
Arun-gox/docs-hub@368db4f21aac0ba1dba87cc9ddd1aa447e849d70 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/Arun-gox
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@368db4f21aac0ba1dba87cc9ddd1aa447e849d70 -
Trigger Event:
push
-
Statement type:
File details
Details for the file docs_hub-0.1.3-py3-none-any.whl.
File metadata
- Download URL: docs_hub-0.1.3-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4e11a076d240342c05e065699c3b2c9ccd4bf76d2cf34abdbb4dda200e2bdda
|
|
| MD5 |
56c1cd8f647e9cbf5fb46b635f253b1c
|
|
| BLAKE2b-256 |
6cab4a71efae82633cf8994ce8d3f13c8e6ef98c0dd4c104907f077370e2c0f0
|
Provenance
The following attestation bundles were made for docs_hub-0.1.3-py3-none-any.whl:
Publisher:
publish.yml on Arun-gox/docs-hub
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
docs_hub-0.1.3-py3-none-any.whl -
Subject digest:
a4e11a076d240342c05e065699c3b2c9ccd4bf76d2cf34abdbb4dda200e2bdda - Sigstore transparency entry: 2524260432
- Sigstore integration time:
-
Permalink:
Arun-gox/docs-hub@368db4f21aac0ba1dba87cc9ddd1aa447e849d70 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/Arun-gox
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@368db4f21aac0ba1dba87cc9ddd1aa447e849d70 -
Trigger Event:
push
-
Statement type:
