music_theory_docs (Work in progress)

A web-based documentation site for my music_theory Python package, built using Django.

Documentation is extracted from the docstrings in functions, classes, and methods throughout the project. Usage examples are rendered from a Markdown file and python syntax is highlighted.

About

Technologies Used

  • Python
  • Django
  • HTML
  • CSS

Packages Used

  • Python-Markdown
    • To convert markdown files into HTML within Django.
  • Pygments
    • For highlighting Python syntax in the examples page.

Resources Used

  • github-markdown-css
    • To display pages styled to match GitHub’s native Markdown rendering.