documentation system
Sphinx + Furo. RST sources in docs/. Autodoc reads the package. GitHub Pages host is pyjiit.codelif.in (CNAME written in CI). README.rst points there.
Build steps: Building documentation. Deploy: Documentation deployment. RST habits: Contributing to documentation.
flowchart LR RST["docs/*.rst"] --> Sphinx["sphinx-build -b html"] Py["pyjiit/*.py docstrings"] --> Autodoc Autodoc --> Sphinx Conf["docs/conf.py"] --> Sphinx Sphinx --> HTML["docs/_build/html"] HTML --> Pages["gh-pages"]
Pages#
| RST | Content |
|---|---|
index.rst |
toctree |
introduction.rst |
features, roadmap, deps (including the joke ones) |
design.rst |
placeholder |
usage.rst |
pip, Webportal, CAPTCHA, attendance, subjects |
apiref.rst |
autodoc |
design.rst is one sentence: still work in progress.
project = "pyjiit"copyright = "2025, Harsh Sharma"release = "0.1.0a8"sys.pathinserts the repo root so autodoc importspyjiit- extensions:
sphinx.ext.autodoc,sphinx.ext.githubpages html_theme = "furo"- footer GitHub icon URL:
https://github.com/codelif/pyjiit
flowchart TB Index["index.rst"] --> Intro["introduction"] Index --> Design["design"] Index --> Usage["usage"] Index --> API["apiref autodoc"]