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-scan marker 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".

Project links

Data verified by PyPI on Aug 17, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.5)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for aruneshwaran from gravatar.com aruneshwaran

GitHub Statistics

Data verified by PyPI on Aug 17, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT)

Requires

Python >=3.9

Tags

documentation markdown html monorepo cron index

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docs_hub-0.1.1.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docs_hub-0.1.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file docs_hub-0.1.1.tar.gz.

File metadata

  • Download URL: docs_hub-0.1.1.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for docs_hub-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cf9885f5110cd82eba439a5215a89e44d96f216d6e9a3521d35dade2d41031c5
MD5 fb13531c06f98ec414b8777623cb70ee
BLAKE2b-256 55f932fd55f287a4c9be18127584822a7d1f6ad3b465ed98f675088d393c5a06

See more details on using hashes here.

Provenance

The following attestation bundles were made for docs_hub-0.1.1.tar.gz:

Publisher: publish.yml on Arun-gox/docs-hub

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docs_hub-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: docs_hub-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for docs_hub-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bb3751626520ea6ad69ca3b66b64506e5ce158d2722a0cd5743bed22c3590232
MD5 5bbe77347bc619d06fd541cc682674d8
BLAKE2b-256 77109d770c57f0dc4cb13c515411f161ccfdffa70c61f7894c8a4bc6b83e6f1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for docs_hub-0.1.1-py3-none-any.whl:

Publisher: publish.yml on Arun-gox/docs-hub

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

This release

0.1.1 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page