Skip to content

Latest commit

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

NortheBridge appdocs hub

Parent Read the Docs project for appdocs.northebridge.com. Each NortheBridge app's documentation is hosted as an RTD subproject under this one and served at:

appdocs.northebridge.com/projects/<app-slug>/

This repo only owns the umbrella landing page. Per-app docs live in their own repositories with their own .readthedocs.yaml.

Build locally

python3 -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt
sphinx-build -b html docs docs/_build/html
open docs/_build/html/index.html

Adding a new app

  1. Create the per-app RTD project from its GitHub repo.
  2. In this project's RTD admin → Subprojects → Add subproject, pick the new project and set its slug.
  3. Add it to docs/index.md (grid card + hidden toctree entry) and to intersphinx_mapping in docs/conf.py.
  4. Commit and push — RTD rebuilds this hub automatically.

About

Documentation hub for NortheBridge apps (appdocs.northebridge.com)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors