Skip to content

Template Repository Docs

This is docs built for template repository using mkdocs.org.

Using Mkdocs

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

  • This repository has a prebuilt CI in the .github folder.
  • It checks for docs building. Black code formatting.
  • Also it runs the tests written in Pytest.
  • Docs folder has this documentation as made by mkdocs.